PrlDispCfg_SetProxyConnectionCreds Function

Specifies credentials for establishing a proxy connection.

Syntax

PRL_RESULT PrlDispCfg_SetProxyConnectionCreds(
    PRL_HANDLE hDispConfig, 
    PRL_CONST_STR sAccountId, 
    PRL_CONST_STR sPassword, 
    PRL_UINT32 nFlags
);

File

PrlApiDisp.h

Parameters

hDispConfig

A handle of type PHT_DISP_CONFIG.

sAccountId

[in] user login (expected null terminated string in UTF-8 encoding).

sPassword

[in] user password (expected null terminated string in UTF-8 encoding).

nFlags

[in] flags mask for advanced proxy connection configuration. Possible values:

PSPCF_DO_NOT_CLEAN_CREDS

close proxy connection but keep user credentials in the dispatcher security storage for later usage.

PSPCF_REUSE_AVAILABLE_CREDS

restore proxy connection using the credentials in the security storage that were previously saved with the PSPCF_DO_NOT_CLEAN_CREDS flag.

PSPCF_CLEANUP_CREDS

delete user credentials from the dispatcher security storage that were previously saved with the PSPCF_DO_NOT_CLEAN_CREDS flag.

Returns

PRL_RESULT. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle was passed. PRL_ERR_SUCCESS - function completed successfully.

Remarks

To disconnect from the proxy, specify the account or the password as NULL or an empty string. Please note that it is not possible to disconnect from the proxy and reconnect to it with new credentials in a single configuration edit transaction.

Links

PHT_DISP_CONFIG