PrlBootDev_IsInUse Function

Determines whether the boot device is enabled or disabled.

Syntax

PRL_RESULT PrlBootDev_IsInUse(
    PRL_HANDLE hVmBootDev, 
    PRL_BOOL_PTR pbInUse
);

File

PrlApi.h

Parameters

hVmBootDev

A handle of type PHT_BOOT_DEVICE identifying the boot device.

pbInUse

[out] Pointer to a variable that receives the result PRL_TRUE indicates that the device is enabled. PRL_FALSE indicates otherwise.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

A boot device can be either enabled or disabled. If a device is disabled, it is ignored during the boot operation. To change the status of a device, use the PrlBootDev_SetInUse function.