Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlLoginParams_GetUserIdentity Function
PHT_LOGIN_PARAMS

Gets login parameters user identity string.

Syntax
PRL_RESULT PrlLoginParams_GetUserIdentity(
    PRL_HANDLE hParams, 
    PRL_STR pStr, 
    PRL_UINT32_PTR pSz
);
File

PrlApiDisp.h

Parameters

hParams
[in] A handle of type PHT_LOGIN_PARAMS identifying the parameters object.
pStr
[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).
pSz
[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

Returns

PRL_RESULT. Possible values are: 

PRL_ERR_INVALID_ARG - Invalid handle or null pointer was passed. PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter that is used to specify the size will contain the required size. PRL_ERR_SUCCESS - Function completed successfully. 

Links
© 2021 Parallels International GmbH. All rights reserved.