Terminal Emulator - RTE Vuser Functions (TE) > RTE Error Codes > Remote Desktop Protocol Vuser Functions (RDP) > Alphabetical List of Functions > rdp_mouse_wheel


Emulates a mouse wheel turn on an RDP client.

Example: rdp_mouse_wheel Mouse Functions

int rdp_mouse_wheel( "StepDescription=<step_description>", "Snapshot=<snapshot>", ["ConnectionID=<connection_identifier>",] "MouseX=<x_pos>", "MouseY=<y_pos>", "WheelDirection=<Up|Down>", "WheelUnits=<num_units>", "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 not required.
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.
WheelDirection The turn direction.
WheelUnits The number of units turned.
KeyModifier The number

The 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.

Default. Use the option specified in the run-time settings.

RDP_LAST The delimiter marking the end of the argument list.

The rdp_mouse_wheel function emulates a mouse wheel turn at MouseX, MouseY with the specified modifier keys pressed.