Edit

GetPhysicalMonitorDescription function

  • Article

Important

This function is used by the monitor configuration API to access functionality in the display driver. Applications should not call this function.

Gets a description of a physical monitor.

Syntax

NTSTATUS WINAPI GetPhysicalMonitorDescription(
  _In_  HANDLE hMonitor,
  _In_  DWORD  dwPhysicalMonitorDescriptionSizeInChars,
  _Out_ LPWSTR szPhysicalMonitorDescription
);

Parameters

hMonitor [in]

A handle to a physical monitor.

dwPhysicalMonitorDescriptionSizeInChars [in]

The number of characters in the szPhysicalMonitorDescription array.

szPhysicalMonitorDescription [out]

A pointer to an array that receives the description. The number of elements in the array should be at least PHYSICAL_MONITOR_DESCRIPTION_SIZE.

Return value

If the method succeeds, it returns STATUS_SUCCESS. Otherwise, it returns an NTSTATUS error code.

Remarks

Instead of using this function, applications should call one of the following functions:

This function has no associated import library. To call this function, you must use the LoadLibrary and GetProcAddress functions to dynamically link to Gdi32.dll.

Requirements

Requirement Value
Minimum supported client
 Windows Vista [desktop apps only]
Minimum supported server
 Windows Server 2008 [desktop apps only]
DLL
Gdi32.dll

See also

Monitor Configuration Functions