PrlBootDev_GetSequenceIndex Function

Obtains the boot device sequence index.

Syntax

PRL_RESULT PrlBootDev_GetSequenceIndex(
    PRL_HANDLE hVmBootDev, 
    PRL_UINT32_PTR pnSequenceIndex
);

File

PrlApiVm.h

Parameters

hVmBootDev

A handle of type PHT_BOOT_DEVICE identifying the boot device.

pnSequenceIndex

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

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

The boot device sequence index starts with 0. When a virtual machine is powered on, it will first try to boot from the boot device that has a sequence index of 0. If it cannot boot from the device, it will try to boot from the device with sequence index 1, and so forth.