This file describes syntax of 24U VirtualUser Plug-In's functions.
Returns version string of the active 24U VirtualUser Plug-In, formatted as requested by the parameter.
versionFormat | Defines the format of the returned version. |
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 |
Attempts to unlock (register) your copy of 24U VirtualUser Plug-In with the specified code.
registrationCode | The code to unlock the full version of the plug-in. |
If the code is valid, 24U VirtualUser Plug-In gets unlocked and stays in this state until you quit the FileMaker Pro 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.
Records user actions.
recordOption | Parameter describing what type of action should be performed. |
recordOption | Description |
---|---|
"start" | Call VUser_Record ( "start" ) to start recording all user actions. |
"stop" | This will cause that the plug-in will stop all recording actions. |
"read" | Use this value to get "action string". Action string is a list with recorded actions |
"clear" | This parameter value will cause that current recorded action string will be deleted. |
The general function for recording user actions and to obtain recorded information.
For "start" and "clear" parameter values the function returns 0 if successfull. For "stop" and "read" it returns action string. The function returns negative error code in the case of error.
VUser_Record( "start" )
The plug-in will start recording.
Replays actions sequence passed by parameter.
actionString | The action string with correct syntax. |
timeOrSeconds | Specifies the time to wait before replaying. The default value is 0. |
The actionString parameter contains the list of actions delimited by the line break "¶". There are five types of actions:
action = actionMove | actionType | actionClick | actionWait | actionRun
action | syntax | Description | |
---|---|---|---|
actionMove | "move " & X & "," & Y { & " " & durationInSeconds } | Moves mouse cursor to the specified position on the screen. The coordinates have the absolute meaning starting from upper-left corner of the screen. The durationInSeconds indicates how long it takes to move the cursor. The default durationInSeconds is 0 - the cursor is moved immediately. | |
actionType | "type " { & "shift " } & charOrKey | Virtually presses the key on the keyboard. The possible valuas are: "a"..."z", "0"..."9", "up", "down", "left", "right", "delete", "backspace", "space" and "tab". The "shift " is optional. | |
actionClick | { "shift " } "click" | Virtually presses the left (primary) mouse button. The "shift " causes to press the shift key along the mouse button. | |
actionWait | "wait " numberOfSeconds | This will wait for the specified number of seconds and do nothing. | |
actionRun | "run " nameOfExistingScript | The plug-in will trigger the existing script. |
This parameter should contain either number of seconds of the type FileMaker Number or a string in this format:
hours & ":" & minutes & ":" & seconds
Hours, minutes and seconds are two digit integer numbers.
The general function for replaying recorded events.
Function returns 0 when replay was finished sucessfully. In case of error the function returns negative error code.
VUser_Replay( "wait 1¶move 50,60¶click" )
The plug-in will wait for one second, move mouse cursor to position 50,60 and clicks the primary mouse button.
VUser_Replay( "type shift h¶type a¶type l¶type l¶type o" )
The plug-in will type "Hallo" on the keyboard.
VUser_Replay( "run DialogScript¶type y¶type e¶type s¶move 130,60¶click" ; "11:16:04")
The plug-in will wait until the system time is 11:16:04 and than it trigger the FileMaker script with name DialogScript. The plug-in will type "yes", move cursor to the position 130,60 and click the left button.