Share this page

# rdp_sync_on_server_disconnect

Waits until a disconnection from an RDP server is complete.

Synchronization Functions

int rdp_sync_on_server_disconnect( "StepDescription=step_description", ["ConnectionID=connection_identifier",] "Timeout=timeout_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 not required.
Timeout | The wait time in seconds. If the timeout is exceeded, the function returns LR_FAIL. If no timeout is passed, the default value is taken from the runtime settings.
RDP_LAST | The delimiter marking the end of the argument list.

The rdp_sync_on_server_disconnect function waits until a disconnection from an RDP server is complete.

## Example

The following shows synchronization on a disconnection from a server.

Copy code

    rdp_sync_on_server_disconnect(
        "StepDescription=Sync on Server Disconnect 1",
        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: