PrlVmCfg_GetBootDev Function

Obtains a handle of type PHT_BOOT_DEVICE containing information about a specified device from the virtual machine boot device priority list.

Syntax

PRL_RESULT PrlVmCfg_GetBootDev(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32 nBootDevIndex, 
    PRL_HANDLE_PTR phVmBootDev
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nBootDevIndex

An index identifying the device (beginning with 0). To determine the number of the devices in the boot device list, use the PrlVmCfg_GetBootDevCount function.

phVmBootDev

[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.

Remarks

It is the responsibility of the called to free the handle when it is no longer needed.

Links

PrlApi.h, PHT_VM_CONFIGURATION