PrlVmCfg_GetHardDisk Function

Obtains a handle of type PHT_VIRTUAL_DEV_HARD_DISK containing the specified virtual hard disk information.

Syntax

PRL_RESULT PrlVmCfg_GetHardDisk(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nIndex

An index identifying the hard disk instance (beginning with 0). To get the number of hard disks installed in the virtual machine, use the PrlVmCfg_GetHardDisksCount function.

phDevice

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

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed, or device index out of bound.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VM_CONFIGURATION