DEVICE_ACTIVE_COOLING routine

The ActiveCooling callback routine engages or disengages a device's active-cooling function.

Syntax

DEVICE_ACTIVE_COOLING ActiveCooling;

void ActiveCooling(
  _Inout_opt_ PVOID   Context,
  _In_        BOOLEAN Engaged
)
{ ... }

Parameters

• Context [in, out, optional]
  A pointer to interface-specific context information. The caller sets this parameter to the value of the Context member of the THERMAL_COOLING_INTERFACE structure that the driver previously supplied to the caller.

• Engaged [in]
  Indicates whether to engage or disengage active cooling. If TRUE, the driver must engage active cooling (for example, by turning the fan on). If FALSE, the driver must disengage active cooling (for example, by turning the fan off).

Return value

None.

Remarks

The driver for a device that has active-cooling capabilities can implement this routine to enable the operating system to engage or disengage the active-cooling function in the device.

For example, if the active-cooling function is a fan that can be turned on and off, the caller sets Engaged = TRUE to turn the fan on, and sets Engaged = FALSE to turn the fan off.

Initially, before the first call to the ActiveCooling routine, the active-cooling function in the device must be disengaged (for example, the fan must be turned off).

The driver for a device that does not have active-cooling capabilities should set the ActiveCooling member of the THERMAL_COOLING_INTERFACE structure to NULL.

For more information about active cooling, see Passive and Active Cooling Modes.

Requirements

See also

THERMAL_COOLING_INTERFACE

Send comments about this topic to Microsoft