PrlDisk_OpenDiskEx Function

This function can be used to open an existing virtual disk locally without being connected to the Parallels Service.

Syntax

PRL_RESULT PrlDisk_OpenDiskEx(
    PRL_HANDLE hParams, 
    PRL_HANDLE_PTR phDisk
);

File

PrlDisk.h

Parameters

hParams

[in] A handle of type PHT_VIRTUAL_DISK_OP_PARAMS identifying the open parameters object. To open a disk following parameters should be set : Name and OpenFlags (see PrlDiskParams_SetName, PrlDiskOpParams_SetDiskOpenFlags)

phDisk

[out] A handle of type PHT_VIRTUAL_DISK identifying the new virtual disk. You must always free the handle using the PrlDisk_Free function when the handle is no longer needed. Failure to do so will result in memory leak.

Returns

PRL_RESULT. Possible values are:

PRL_ERR_INVALID_ARG - Invalid handle or null pointer was passed. PRL_ERR_OUT_OF_MEMORY - Not enough memory to create an object. PRL_ERR_SUCCESS - Function completed successfully.

Remarks

The function opens a virtual disk and obtains a handle of type PHT_VIRTUAL_DISK identifying the disk. The handle can then be used to perform other operations on the disk if necessary (see other functions from this group).