Share this page

# rdp_disconnect_server

Disconnects a client from an RDP server.

Connection Functions

int rdp_disconnect_server( "StepDescription=<step_description>", "ConnectionID=<connection identifier>", 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.
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.
RDP_LAST | A delimiter marking the end of the argument list.

The rdp_disconnect_server function disconnects a client from an RDP server.

## Example

The following example shows disconnecting from the server.

Copy code

    rdp_disconnect_server(
        "StepDescription=Disconnect_From_Server",
        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: