Share this page

# rdp_mouse_move

Emulates a mouse move on an RDP client.

Mouse Functions

int rdp_mouse_move( "StepDescription=<step_description>", "Snapshot=<snapshot>", ["ConnectionID=<connection_identifier>", ] "MouseX=<x_pos>", "MouseY=<y_pos>", ["KeyModifier=<key_modifier>",] "Origin=<Recorded|Synched|Default>", RDP_LAST );

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure. Note that LR_PASS and LR_FAIL generally indicate whether the function call completed without an exception, and not that the test step succeeded.

All string arguments (char type) can be parameterized using standard parameterization.

Argument | Description
--- | ---
StepDescription | A descriptive, unique name for this step. Use any text.
Snapshot | The name of the snapshot file of the screen state before this step.
ConnectionID | The name of the connection on which this function operates. Do not change the recorded ID. If several connections are open and the ID is not specified, the first connection in the script is used. If only one connection is open, the connection ID is unnecessary.
MouseX | The horizontal distance of the mouse from the left edge of the active window at the end of the move.
MouseY | The vertical distance of the mouse from the top edge of the active window at the end of the move.
KeyModifier | The modifier key pressed while performing this operation. Use a comma-separated list to indicate that more than one key is used, for example: "KeyModifier=M1,M2" Optional For a list see Modifier Key Values.
Origin | Specifies which set of coordinates to use. Possible values are: Recorded (the exact recorded coordinates), Synched (the adjusted coordinates using the offset from the last image synchronization), and Default (use the option specified in the runtime settings).
RDP_LAST | The delimiter marking the end of the argument list.

The rdp_mouse_move function moves the mouse to MouseX, MouseY. This function is generally not recorded. It can be added manually when enhancing the script.

## Example

The following example shows mouse movement.

Copy code

    rdp_mouse_move(
        "StepDescription=Mouse Move 1",
        "Snapshot=snapshot_1.inf",
        "MouseX=616",
        "MouseY=426",
        "Origin=Default",
        RDP_LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: