PowerReportThermalEvent function (powrprof.h)

Article
02/22/2024

Notifies the operating system of thermal events.

Syntax

DWORD PowerReportThermalEvent(
  [in] PTHERMAL_EVENT Event
);

Parameters

[in] Event

The thermal event structure, THERMAL_EVENT.

Return value

Returns ERROR_SUCCESS (zero) if the call was successful, and a nonzero value if the call failed.

Remarks

Thermal managers call the PowerReportThermalEvent routine to notify the operating system of a thermal event so that the event can be recorded in the system event log.

Before calling PowerReportThermalEvent, the thermal manager sets the members of the THERMAL_EVENT structure to describe the thermal event.

Requirements

Requirement	Value
Minimum supported client	Windows 8.1 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	powrprof.h
Library	PowrProf.lib
DLL	PowrProf.dll