IDesktopWallpaper::GetMonitorDevicePathAt method (shobjidl_core.h)

Article
02/22/2024

Retrieves the unique ID of one of the system's monitors.

Syntax

HRESULT GetMonitorDevicePathAt(
  [in]  UINT   monitorIndex,
  [out] LPWSTR *monitorID
);

Parameters

[in] monitorIndex

The number of the monitor. Call GetMonitorDevicePathCount to determine the total number of monitors.

[out] monitorID

A pointer to the address of a buffer that, when this method returns successfully, receives the monitor's ID.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code, including the following.

Return code	Description
E_POINTER	A NULL pointer was provided in monitorID.

Remarks

This method can be called on monitors that are currently detached but that have an image assigned to them. Call GetMonitorRECT to distinguish between attached and detached monitors.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)