PrlApi_GetUserData Function

Allows to get arbitrary data from the cloud user storage.

Syntax

PRL_HANDLE PrlApi_GetUserData(
    PRL_CONST_STR account, 
    PRL_CONST_STR accountPass, 
    PRL_PROXY_CLIENT_INFO_PTR cliInfo, 
    PRL_CONST_STR regExp, 
    PRL_UINT32 timeout, 
    PRL_EVENT_HANDLER_PTR handler, 
    PRL_VOID_PTR userData, 
    PRL_UINT32 flags
);

File

PrlApiManager.h

Parameters

account

Parallels account ID.

accountPass

Parallels account password.

cliInfo

Additional client information (e.g. alternative manager URL). Can be null for default settings.

regExp

A regular expression which matches to correspond required data identifiers.

timeout

Timeout in milliseconds. The authentication operation will stop once this limit is reached.

handler

Optional. A pointer to a user callback function (event handler) that will be called on operation completion.

userData

Optional. A pointer to a user data that will be passed to the optional callback function.

flags

Optional. Reserved for future needs.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

To get the results from the PHT_JOB object use PrlJob_GetDataPtr . Result will be represented as a set of PRL_PROXY_USER_DATA structures.

Possible return codes: PRL_ERR_SUCCESS - operation completed successfully PRL_ERR_XMLRPC_INVALID_CREDENTIALS - wrong user credentials were provided PRL_ERR_XMLRPC_LIMITS_EXHAUSTED - remote server is busy for now - analogue of EAGAIN PRL_ERR_XMLRPC_INTERNAL_ERROR - error occurred during XML RPC interoperation PRL_ERR_FAILURE - operation failed on remote side

Links

System Functions