GetMonitorColorTemperature function

Retrieves a monitor's current color temperature.

Syntax


BOOL GetMonitorColorTemperature(
  _In_   HANDLE hMonitor,
  _Out_  LPMC_COLOR_TEMPERATURE pctCurrentColorTemperature
);

Parameters

hMonitor [in]

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

pctCurrentColorTemperature [out]

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]

Header

HighLevelMonitorConfigurationAPI.h

Library

Dxva2.lib

DLL

Dxva2.dll

See also

Monitor Configuration Functions

 

 

Community Additions

ADD
Show: