PrlBootDev_GetIndex Function

Obtains the boot device index.

Syntax

PRL_RESULT PrlBootDev_GetIndex(
    PRL_HANDLE hVmBootDev, 
    PRL_UINT32_PTR pnDevIndex
);

File

PrlApi.h

Parameters

hVmBootDev

A handle of type PHT_BOOT_DEVICE identifying the boot device.

pnDevIndex

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

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Device index is a property that, together with device type, is used to uniquely identify a device in the boot priority list of a virtual machine. The index should be the same index the device has in the main virtual machine configuration, which is determined using the PrlVmDev_GetIndex function.