Edit

Share via

GetMonitorDisplayAreaPosition function (highlevelmonitorconfigurationapi.h)

  • Article

Warning

The physical monitor configuration functions work using the VESA Monitor Control Command Set (MCCS) standard over an I2C 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 horizontal or vertical position.

Syntax

_BOOL GetMonitorDisplayAreaPosition(
  [in]  HANDLE           hMonitor,
  [in]  MC_POSITION_TYPE ptPositionType,
  [out] LPDWORD          pdwMinimumPosition,
  [out] LPDWORD          pdwCurrentPosition,
  [out] LPDWORD          pdwMaximumPosition
);

Parameters

[in] hMonitor

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

[in] ptPositionType

A member of the MC_POSITION_TYPE enumeration, specifying whether to retrieve the horizontal position or the vertical position.

[out] pdwMinimumPosition

Receives the minimum horizontal or vertical position.

[out] pdwCurrentPosition

Receives the current horizontal or vertical position.

[out] pdwMaximumPosition

Receives the maximum horizontal or vertical position.

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

This function takes about 40 milliseconds to return.

The horizontal and vertical position 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

See also

Monitor Configuration Functions