Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlUsrInfo_GetDefaultVmFolder Function
PHT_USER_INFO  See Also

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

Syntax
PRL_RESULT PrlUsrInfo_GetDefaultVmFolder(
    PRL_HANDLE hUserInfo, 
    PRL_STR sDefaultVmFolder, 
    PRL_UINT32_PTR pnDefaultVmFolderBufLength
);
File

PrlApiDisp.h

Parameters

hUserInfo
A handle of type PHT_USER_INFO 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 directory, the function will return the name and path of the default directory for this Parallels Service. To set a default virtual machine directory for a user, use the PrlUsrCfg_SetDefaultVmFolder function.

See Also
Links
© 2021 Parallels International GmbH. All rights reserved.