PrlBootDev_SetInUse Function

Enables or disables the boot device.

Syntax

PRL_RESULT PrlBootDev_SetInUse(
    PRL_HANDLE hVmBootDev, 
    PRL_BOOL bInUse
);

File

PrlApi.h

Parameters

hVmBootDev

A handle of type PHT_BOOT_DEVICE identifying the boot device.

bInUse

A boolean value specifying the action type. PRL_TRUE enables a device, PRL_FALSE disables it.

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

A boot device can be enabled or disabled without being removed from the boot device priority list. If the device is disabled, it is ignored during the boot operation. To obtain the current status of a device, use the PrlBootDev_IsInUse function. To permanently remove a device from the list, use the PrlBootDev_Remove function.