PrlBootDev_SetIndex Function

Sets the boot device index.

Syntax

PRL_RESULT PrlBootDev_SetIndex(
    PRL_HANDLE hVmBootDev, 
    PRL_UINT32 nDevIndex
);

File

PrlApiVm.h

Parameters

hVmBootDev

A handle of type PHT_BOOT_DEVICE identifying the boot device.

nDevIndex

The index of the device of interest as it exists in the virtual machine configuration.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or the device has been removed from the boot list.

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 virtual machine boot priority list. The index must be the same index the device has in the main virtual machine configuration or it will not be recognized during the boot procedure. To obtain a virtual device index from the virtual machine configuration, use the PrlVmDev_GetIndex function.