PrlBootDev_SetType Function

Sets the boot device type.

Syntax

PRL_RESULT PrlBootDev_SetType(
    PRL_HANDLE hVmBootDev, 
    PRL_DEVICE_TYPE nDevType
);

File

PrlApiVm.h

Parameters

hVmBootDev

A handle of type PHT_BOOT_DEVICE identifying the boot device.

nDevType

The device type to set.

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

Use this function when adding a device to the boot device priority list. Device type is a property that, together with device index, is used to uniquely identify a device in a virtual machine boot list. When adding a device to the boot priority list, these properties must be set correctly or the device will not be recognized. The supported device types are defined in the PRL_DEVICE_TYPE enumeration.