Share this page
rdp_mouse_button_down
Emulates pressing a mouse button on an RDP client.
| Example: rdp_mouse_button_down | Mouse Functions |
int rdp_mouse_button_down( "StepDescription=<step_description>", "Snapshot=<snapshot>", ["ConnectionID=<connection_identifier>",] "MouseX=<x_pos>", "MouseY=<y_pos>", "MouseButton=<mouse_button>", ["KeyModifier=<ALT_KEY|RALT_KEY|SHIFT_KEY|CONTROL_KEY>",] "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. |
| 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". |
| MouseX | The horizontal distance of the mouse from the left edge of the active window. |
| MouseY | The vertical distance of the mouse from the top edge of the active window. |
| KeyModifier | Modifier keys pressed while performing this mouse operation. |
| 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_button_down function emulates pressing a mouse button while the mouse points to the location specified by MouseX and MouseY.
This function is recorded only when the Generate Raw Keyboard Calls in the Recording Options dialog box is selected or if the Script Level is set to Raw.
