GetMonitorColorTemperature function

Retrieves a monitor's current color temperature.

Syntax

_BOOL GetMonitorColorTemperature(
  HANDLE                 hMonitor,
  LPMC_COLOR_TEMPERATURE pctCurrentColorTemperature
);

Parameters

hMonitor

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

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

   
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

See Also

Monitor Configuration Functions