GetMonitorDisplayAreaSize function (Windows)

Applies to: desktop apps only

Retrieves a monitor's minimum, maximum, and current width or height.

Syntax

BOOL GetMonitorDisplayAreaSize(
  __in   HANDLE hMonitor,
  __in   MC_SIZE_TYPE stSizeType,
  __out  LPDWORD pdwMinimumWidthOrHeight,
  __out  LPDWORD pdwCurrentWidthOrHeight,
  __out  LPDWORD pdwMaximumWidthOrHeight
);

Parameters

hMonitor [in]

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

stSizeType [in]

A member of the MC_SIZE_TYPE enumeration, specifying whether to retrieve the width or the height.

pdwMinimumWidthOrHeight [out]

Receives the minimum width or height.

pdwCurrentWidthOrHeight [out]

Receives the current width or height.

pdwMaximumWidthOrHeight [out]

Receives the maximum width or height.

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

This function takes about 40 milliseconds to return.

The width and height settings are continuous monitor settings. 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