PrlVmCfg_GetSharesCount Function

Determines the number of shared folders in a virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetSharesCount(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32_PTR pnSharesCount
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pnSharesCount

[out] A pointer to a variable that receives the result.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

A shared folder is a folder in the host OS which is shared with a given virtual machine. To obtain its information, first determine the number of the available shared folders using the PrlVmCfg_GetSharesCount function. Then obtain information about an individual folder using the PrlVmCfg_GetShare function.

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

Links

PHT_VM_CONFIGURATION