Share this page

# rdp_raw_key_up

Emulates releasing a key on an RDP client.

Keyboard Functions

int rdp_raw_key_up( "StepDescription=<step_description>", "Snapshot=<snapshot>", ["ConnectionID=<connection_identifier>", ]"KeyValue=<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.
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.
KeyValue | The name of the key. The key can be printable or non-printable keys. For a list see Key Names
RDP_LAST | The delimiter marking the end of the argument list.

The rdp_raw_key_up function emulates a user releasing a key on the keyboard.

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.

## Example

The following example shows the Return key being released.

Copy code

    rdp_raw_key_up(
        "StepDescription=Key Release 10",
        "Snapshot=snapshot_56.inf",
        "KeyValue=VK_RETURN",
        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: