Share this page

# rdp_connect_server

Connects a client to an RDP server.

Example: rdp_connect_server | Connection Functions

int rdp_connect_server( "Host=<computer name>",["ConnectionID=<connection identifier>", ]"UserName=<user name>", ["Password=<password>",] ["EncryptedPassword=<password>",] "Domain=<domain>", 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
--- | ---
Host | The name of the RDP server.
ConnectionID | The name of the connection upon 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.
Domain | The network domain for logging on to the RDP server.
UserName | The user name for logging on to the RDP Server.
Password | The non-encrypted password for logging on to the RDP server in unencrypted form.
EncryptedPassword | The encrypted password for logging on to the RDP server.
RDP_LAST | A delimiter marking the end of the argument list.

The rdp_connect_server function connects to an RDP server and creates a client session.

Tips to improve your search results... VuGen Function Reference Version 25.1-25.3 Function Reference 25.1-25.3 All View Local Help Center View Online Help Center Version: