IXpsOMPath::SetAccessibilityLongDescription method

项目
06/01/2017

Sets the long (detailed) textual description of the object's contents. This description is used by accessibility clients to describe the object.

Syntax

HRESULT SetAccessibilityLongDescription(
  [in] LPCWSTR longDescription
);

Parameters

longDescription [in]
The detailed 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 longDescription will be that of the AutomationProperties.HelpText attribute of the Path element.

Requirements

Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| Windows Store apps]
Header	Xpsobjectmodel.h
IDL	XpsObjectModel.idl