PrlVmCfg_SetShareUserHomeDir Function

Enables sharing of host user home dir for the specified virtual machine.

Syntax

PRL_RESULT PrlVmCfg_SetShareUserHomeDir(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bShareUserHomeDir
);

File

PrlApi.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 host user home dir to guest OS. Specify PRL_FALSE to not 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 sign switched on host user home dir will be shared into guest OS. Note that host sharing should be switched on to enable this functionality.

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

Links

PrlApi.h , PHT_VM_CONFIGURATION