PrlUsrCfg_GetDefaultVmFolder Function

Returns name and path of the default virtual machine directory for this user.

Syntax

PRL_RESULT PrlUsrCfg_GetDefaultVmFolder(
    PRL_HANDLE hUserProfile, 
    PRL_STR sDefaultVmFolder, 
    PRL_UINT32_PTR pnDefaultVmFolderBufLength
);

File

PrlApiDisp.h

Parameters

hUserProfile

A handle of type PHT_USER_PROFILE identifying the user.

sDefaultVmFolder

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

pnDefaultVmFolderBufLength

[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 the user doesn't have a default virtual machine folder (if it was not previously set up by the PrlUsrCfg_SetDefaultVmFolder function call), the function returns an empty string. In such a case, use the PrlUsrCfg_GetVmDirUuid function to get the virtual machine folder for the Parallels Service, which is used by default for all users.