IXpsOMCanvas::GetAccessibilityShortDescription method (xpsobjectmodel.h)

Article
02/22/2024

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

Syntax

HRESULT GetAccessibilityShortDescription(
  [out, retval] LPWSTR *shortDescription
);

Parameters

[out, retval] shortDescription

The short textual description of the object's contents. If this description is not set, a NULL pointer is returned.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	shortDescription is NULL.

Remarks

The property returned by this method corresponds to the AutomationProperties.Name attribute of the Canvas element in the document markup.

This method allocates the memory used by the string that is returned in shortDescription. If shortDescription is not NULL, use the CoTaskMemFree function to free the memory.

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