IXpsOMPath::SetAccessibilityShortDescription method (xpsobjectmodel.h)

Article
02/22/2024

Sets the short textual description of the object's contents. This description is used by accessibility clients to describe the object.

Syntax

HRESULT SetAccessibilityShortDescription(
  [in] LPCWSTR shortDescription
);

Parameters

[in] shortDescription

The short textual description of the object's contents.

Return value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Remarks

In the document markup, the value that is set in shortDescription will be that of the AutomationProperties.Name attribute of the Path element.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	xpsobjectmodel.h