GetMonitorBrightness function

Applies to: desktop apps only

Retrieves a monitor's minimum, maximum, and current brightness settings.

Syntax

BOOL GetMonitorBrightness(
  __in   HANDLE hMonitor,
  __out  LPDWORD pdwMinimumBrightness,
  __out  LPDWORD pdwCurrentBrightness,
  __out  LPDWORD pdwMaximumBrightness
);

Parameters

hMonitor [in]

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

pdwMinimumBrightness [out]

Receives the monitor's minimum brightness.

pdwCurrentBrightness [out]

Receives the monitor's current brightness.

pdwMaximumBrightness [out]

Receives the monitor's maximum brightness.

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_BRIGHTNESS flag.

This function takes about 40 milliseconds to return.

The brightness setting is a continuous monitor setting. For more information, see Using the High-Level Monitor Configuration Functions.

Requirements

See also

Monitor Configuration Functions

Send comments about this topic to Microsoft

Build date: 2/3/2012