GetMonitorColorTemperature function (highlevelmonitorconfigurationapi.h)

Article
02/22/2024

Warning

The physical monitor configuration functions work using the VESA Monitor Control Command Set (MCCS) standard over an I²C interface. Many monitors don't fully implement that standard; so your use of these commands might result in undefined monitor behavior. We don't recommend using these functions for arbitrary monitors without physically validating that they work as intended.

Retrieves a monitor's current color temperature.

Syntax

_BOOL GetMonitorColorTemperature(
  [in]  HANDLE                 hMonitor,
  [out] LPMC_COLOR_TEMPERATURE pctCurrentColorTemperature
);

Parameters

[in] hMonitor

Handle to a physical monitor. To get the monitor handle, call GetPhysicalMonitorsFromHMONITOR or GetPhysicalMonitorsFromIDirect3DDevice9.

[out] pctCurrentColorTemperature

Receives the monitor's current color temperature, specified as a member of the MC_COLOR_TEMPERATURE enumeration.

Return value

If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information, call GetLastError.

Remarks

If this function is supported, the GetMonitorCapabilities function returns the MC_CAPS_COLOR_TEMPERATURE flag.

This function takes between 0 and 80 milliseconds to return.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	highlevelmonitorconfigurationapi.h
Library	Dxva2.lib
DLL	Dxva2.dll