PrlDispCfg_GetDefaultVmDir Function

Obtains name and path of the directory in which new virtual machines are created by default.

Syntax

PRL_RESULT PrlDispCfg_GetDefaultVmDir(
    PRL_HANDLE hDispConfig, 
    PRL_STR sDefaultVmDir, 
    PRL_UINT32_PTR pnDefaultVmDirBufLength
);

File

PrlApiDisp.h

Parameters

hDispConfig

A handle of type PHT_DISP_CONFIG.

sDefaultVmDir

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

pnDefaultVmDirBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this 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

The virtual machine directory returned by this function is the default directory for all users and cannot be modified. Individual users can have their own default virtual machine directories if needed. To set a default directory for a user, use the PrlUsrCfg_SetDefaultVmFolder function. If a user has its own virtual machine directory set up, it takes precedence over the directory returned by this function.

Links

PHT_DISP_CONFIG