Skip to content

Commit 004c96a

Browse files
authored
Enhance documentation for StableMonitorId property (#2515)
Updated the description of StableMonitorId to clarify its purpose and stability across different connections.
1 parent b41aeff commit 004c96a

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

windows.devices.display.core/displaytarget_stablemonitorid.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,19 @@ public string StableMonitorId { get; }
1111
# Windows.Devices.Display.Core.DisplayTarget.StableMonitorId
1212

1313
## -description
14-
Gets a value representing a stable monitor identifier.
14+
Gets a value representing a stable identifier string for this monitor which persists no matter which adapter or connector on the adapter the monitor is attached to (see Remarks for exceptions). This string should be treated as an opaque identifier and not parsed. It is not suitable for display to a user but is intended to be used to persist monitor-specific settings.
1515

1616
## -property-value
1717
A string containing the identifier.
1818

1919
## -remarks
20+
Note that [DeviceInterfacePath](displaytarget_deviceinterfacepath.md) does not have this same stability guarantee. Reconnecting the same monitor to a different GPU or a different output on the same GPU can result in the monitor having a different DeviceInterfacePath, but the StableMonitorId should be maintained.
21+
22+
In cases where the system detects two completely identical monitors connected at the same time, the stable identifier will be regenerated to include a reference to its connector to ensure that both monitors have a unique identifier.
23+
24+
Some monitors may expose different hardware identifier information for each input port on the monitor. In this case, the StableMonitorId may vary depending on which input port on the monitor is used.
2025

2126
## -see-also
2227

2328
## -examples
29+

0 commit comments

Comments
 (0)