PrlDisk_OpenDisk Function

Obtains a handle of type PHT_VIRTUAL_DISK identifying an existing virtual disk.

Syntax

PRL_RESULT PrlDisk_OpenDisk(
    PRL_HANDLE_PTR pHandle, 
    PRL_CONST_STR pDiskName, 
    const PRL_DISK_OPEN_FLAGS OpenFlags, 
    PRL_CONST_VOID_PTR pAdditionalFlags
);

File

PrlDisk.h

Parameters

pHandle

[out] A handle of type PHT_VIRTUAL_DISK identifying the virtual disk.

pDiskName

The disk name for which to obtain the handle, in UTF-8 format. Disk name is the same as the bundle name (Mac) or the directory name (Windows, Linux) containing the virtual disk files.

OpenFlags

Disk open parameters. See PRL_DISK Macros for available options.

pAdditionalFlags

Additional flags (not currently used).

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid argument values.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Use this function when you want to view or modify the configuration of an existing virtual disk. Once you obtain the disk handle, use its functions to perform the desired disk manipulations.

Links

PrlDisk.h , PHT_VIRTUAL_DISK