24U VirtualUser Plug-In 1.0.1 Syntax

This file describes syntax of 24U VirtualUser Plug-In's functions.
 

VUser_Version ( { versionFormat } )
 
Returns version string of the active 24U VirtualUser Plug-In, formatted as requested by the parameter. Use:

"short" to get just the version number
"long" to get the plug-in name followed by its version number
"platform" to get the platform of the code currently running
 

VUser_Register ( registrationCode )
 
Attempts to unlock (register) your copy of 24U VirtualUser Plug-In with the specified code. If the code is valid, 24U VirtualUser Plug-In gets unlocked and stays in this state until you quit the FileMaker application, deactivate the plug-in, or the registration code expires. While unlocked, 24U VirtualUser Plug-In is fully functional and does not bother the user with a shareware reminder.
 
Returns a non-zero result when operation is not permitted.
 

VUser_Record ( recordOption )
 
Records user actions.

              recordOption   = "start" | "stop" | "read" | "clear"

              for "start", "clear"

                      Returns zero if successful, negative error code in the case of failure.

              for "stop", "read"

                      Returns action string if successful, negative error code in the case of failure.

 

VUser_Replay ( actionString { ; timeOrSeconds })
 
Replays actions sequence passed by parameter.

actionString = action { & "¶" & action ... }
action = actionMove | actionType | actionClick | actionWait | actionRun
actionMove   = "move " & X & "," & Y { & durationInSeconds }
X integer number, coordinate of destination point on the screen
integer number, coordinate of destination point on the screen
durationInSeconds integer or floating point number
actionType   = "type " { & "shift " } & charOrKey
charOrKey = "a" | ... | "z" | "0" | ... | "9" | "up" | "down" | "left" | "right" | "delete" | "backspace" | "space" | "tab"
actionClick  =  { modKeyComb & " " } "click"
modKeyComb 

= modKey { & " " & modKey... }

modKey

= "control" | "alt" | "command" | "shift"

actionWait

= "wait " numberOfSeconds

numberOfSeconds integer or floating point number
actionRun

= "run " nameOfExistingScript

timeOrSeconds

= numberOfSeconds | formattedTime

numberOfSeconds integer number
formattedTime = hours & ":" & minutes & ":" & seconds
hours two digit integer number
minutes two digit integer number
seconds

two digit integer number

Remark: when specifying modifyer key combination for action "click" keep the order given above, e. g.  "alt shift click", not  "shift alt click" .

Returns zero if successful, negative error code in the case of failure.