Edit

Share via

BatteryClassStatusNotify function (batclass.h)

  • Article

BatteryClassStatusNotify notifies the battery class driver of changes in battery status.

Syntax

NTSTATUS BATTERYCLASSAPI BatteryClassStatusNotify(
  [in] PVOID ClassData
);

Parameters

[in] ClassData

Pointer to a battery class handle previously returned by BatteryClassInitializeDevice.

Return value

BatteryClassStatusNotify returns STATUS_SUCCESS.

Remarks

Battery miniclass drivers must call BatteryClassStatusNotify whenever any of the following occur:

  • The battery goes online or offline.
  • The battery's capacity becomes critically low.
  • The battery's power state changes; that is, the battery starts or stops charging or discharging.
  • The battery's capacity or power state deviates from the criteria set by a previous call to BatteryMiniSetStatusNotify.
The battery class driver queues status requests internally. If any such requests are pending when the miniclass driver calls BatteryClassStatusNotify, the class driver immediately calls the miniclass driver's BatteryMiniQueryStatus routine.

Requirements

Requirement Value
Target Platform Desktop
Header batclass.h (include Batclass.h)
Library Battc.lib

See also

BatteryMiniQueryStatus

BatteryMiniSetStatusNotify