PrlDisk_OpenDisk_Local Function

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

Syntax

PRL_RESULT PrlDisk_OpenDisk_Local(
    PRL_HANDLE_PTR pHandle, 
    PRL_CONST_STR pDiskName, 
    const PRL_DISK_OPEN_FLAGS OpenFlags, 
    PRL_HANDLE hPolicyList
);

File

PrlDisk.h

Parameters

pHandle

[out] A handle of type PHT_VIRTUAL_DISK identifying the 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.

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.

hPolicyList

A handle of type PHT_HANDLE_LIST containing handles of type PHT_VIRTUAL_DISK_OPEN_POLICY representing disk open policies. May be NULL.

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. This function can be used locally without a Virtuozzo Service connection.