PrlVmCfg_SetShareUserHomeDir Function

Enables or disables sharing of the host user home directory in the specified virtual machine.

Syntax

PRL_RESULT PrlVmCfg_SetShareUserHomeDir(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bShareUserHomeDir
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bShareUserHomeDir

The value to set. Specify PRL_TRUE to share the host user home directory. Specify PRL_FALSE not to share it.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

When this feature is enabled, the host user home directory will be shared in the virtual machine. Note that host sharing should be enabled to use this functionality. Parallels Tools must be installed to use this feature. To obtain the Parallels Tools status, use the PrlVm_GetToolsState function.

Links

PHT_VM_CONFIGURATION