PrlUsrCfg_GetVmDirUuid Function

Returns name and path of the default virtual machine folder for this Parallels Service.

Syntax

PRL_RESULT PrlUsrCfg_GetVmDirUuid(
    PRL_HANDLE hUserProfile, 
    PRL_STR sVmDirUuid, 
    PRL_UINT32_PTR pnVmDirUuidBufLength
);

File

PrlApiDisp.h

Parameters

hUserProfile

A handle of type PHT_USER_PROFILE identifying the user.

sVmDirUuid

[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).

pnVmDirUuidBufLength

[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.

Remarks

If a default virtual machine folder has been set up for this user with the PrlUsrCfg_SetDefaultVmFolder function, use the PrlUsrCfg_GetDefaultVmFolder to get its name and path.

Links

PHT_USER_PROFILE