PrlVmCfg_GetShare Function

Obtains a handle of type PHT_SHARE containing information about a shared folder.

Syntax

PRL_RESULT PrlVmCfg_GetShare(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32 nShareIndex, 
    PRL_HANDLE_PTR phVmShare
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nShareIndex

An index identifying the shared folder (beginning with 0). To determine the number of shared folders in a virtual machine, use the PrlVmCfg_GetSharesCount function.

phVmShare

[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 iterate through the list using the iteration number as the nShareIndex parameter value.

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

Links

PHT_VM_CONFIGURATION