Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlVmCfg_IsShareUserHomeDir Function
PHT_VM_CONFIGURATION

Determines whether the host user home directory will be available in the guest OS as a share.

Syntax
PRL_RESULT PrlVmCfg_IsShareUserHomeDir(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL_PTR pbShareUserHomeDir
);
File

PrlApiVm.h

Parameters

hVmCfg
A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.
pbShareUserHomeDir
[out] A pointer to a variable that receives the result. PRL_TRUE indicates that host user home directory will be shared with the guest OS. PRL_FALSE indicates otherwise.

Returns

PRL_RESULT. Possible values: 

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

Remarks

Parallels Tools must be installed to use this feature. To obtain the Parallels Tools status, use the PrlVm_GetToolsState function.

Links
© 2021 Parallels International GmbH. All rights reserved.