Share this page

# rdp_set_lock

Emulates switching a toggle key on.

Keyboard Functions

int rdp_set_lock( "StepDescription=<step_description>", ["ConnectionID=<connection_identifier>",] "LockKeyValue=<key value>", 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.
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.
LockKeyValue | The virtual lockable key name. For a list of lockable keys, see Toggle Key Names
RDP_LAST | The delimiter marking the end of the argument list.

The rdp_set_lock function emulates switching a toggle key on. This function is recorded only when the Generate Raw Keyboard Calls in the Recording Options dialog box is selected.

## Example

The following example shows setting the numlock.

Copy code

    rdp_set_lock(
        "StepDescription=Lock Key Set 1",
        "LockKeyValue=VK_NUMLOCK",
        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: