BCLASS_SET_STATUS_NOTIFY_CALLBACK callback function (batclass.h)

Article
02/22/2024

BatteryMiniSetStatusNotify sets the battery capacity and power state levels at which the class driver requires notification.

Syntax

BCLASS_SET_STATUS_NOTIFY_CALLBACK BclassSetStatusNotifyCallback;

NTSTATUS BclassSetStatusNotifyCallback(
  [in] PVOID Context,
  [in] ULONG BatteryTag,
  [in] PBATTERY_NOTIFY BatteryNotify
)
{...}

Parameters

[in] Context

A pointer to the context area allocated by the miniclass driver for the battery device.

[in] BatteryTag

A battery tag value previously returned by BatteryMiniQueryTag.

[in] BatteryNotify

A pointer to a BATTERY_NOTIFY structure.

Return value

BatteryMiniSetStatusNotify returns one of the following:

Return code	Description
STATUS_SUCCESS	A battery is currently installed.
STATUS_NO_SUCH_DEVICE	No battery is present or the given battery tag is invalid.
STATUS_NOT_SUPPORTED	The miniclass driver cannot distinguish the target condition.

Remarks

The battery class driver calls a miniclass driver's BatteryMiniSetStatusNotify routine to set criteria for an acceptable range of battery conditions. When the battery's capacity or power state deviates from these criteria, the miniclass driver must call BatteryClassStatusNotify to notify the class driver.

In the PowerState member of the BATTERY_NOTIFY structure, the class driver specifies one or more battery power states. Any time the battery enters a power state that is not in PowerState, the miniclass driver must notify the class driver.

In the LowCapacity and HighCapacity members of BATTERY_NOTIFY, the class driver specifies a range of capacity. When the capacity falls above or below this range, the miniclass driver must notify the class driver.

Some batteries might be unable to distinguish the precise capacities requested by the battery class driver. When possible, miniclass drivers for these batteries should attempt to correct for the error so that the user can be informed when the battery approaches a critical state. Otherwise, such drivers should return STATUS_NOT_SUPPORTED.

Requirements

Requirement	Value
Target Platform	Desktop
Header	batclass.h (include Batclass.h)
IRQL	PASSIVE_LEVEL