Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlLoginResponse_GetSessionUuid Function
PHT_LOGIN_RESPONSE

Returns session UUID string (used to restore a session).

Syntax
PRL_RESULT PrlLoginResponse_GetSessionUuid(
    PRL_HANDLE hLoginResp, 
    PRL_STR sSessionUuid, 
    PRL_UINT32_PTR pnSessionUuidBufLength
);
File

PrlApiDisp.h

Parameters

hLoginResp
A handle of type PHT_LOGIN_RESPONSE containing the login response info.
sSessionUuid
[out] A pointer to a buffer that receives the session UUID (a UTF-8 encoded, null-terminated string).
pnSessionUuidBufLength
[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.