Share this page
rdp_mouse_drag
Emulates a mouse drag.
| Example: rdp_mouse_drag | Mouse Functions |
int rdp_mouse_drag( "StepDescription=<step_description>", "Snapshot=<snapshot>", ["ConnectionID=<connection_identifier>",] "MouseStartX=<x_pos>", "MouseStartY=<y_pos>", "MouseEndX=<x_pos>", "MouseEndY=<y_pos>", "MouseButton=<mouse_button>", "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. |
| MouseStartX | The horizontal distance at the beginning of the mouse drag from the left edge of the client window. |
| MouseStartY | The vertical distance at the beginning of the mouse drag from the left edge of the client window. |
| MouseEndX | The horizontal distance at the end of the mouse drag from the left edge of the client window. |
| MouseEndY | The vertical distance at the end of the mouse drag from the top edge of the client window. |
| MouseButton | The mouse button clicked. The mouse buttons are: LEFT_BUTTON, MIDDLE_BUTTON, and RIGHT_BUTTON. Use a comma-separated list to indicate that more than one button is clicked, for example: "MouseButton=M1,M2". |
| 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_drag function emulates a mouse drag from the start point specified by coordinates MouseStartX-MouseStartY to the end point specified by MouseEndX-MouseEndY.
