GetMonitorDisplayAreaSize 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 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

[in] hMonitor

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

[in] stSizeType

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

[out] pdwMinimumWidthOrHeight

Receives the minimum width or height.

[out] pdwCurrentWidthOrHeight

Receives the current width or height.

[out] pdwMaximumWidthOrHeight

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

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