Export (0) Print
Expand All

IXpsOMCanvas::GetAccessibilityLongDescription method

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

Syntax


HRESULT GetAccessibilityLongDescription(
  [out, retval] LPWSTR *longDescription
);

Parameters

longDescription [out, retval]

The long (detailed) textual description of the object's contents. A NULL pointer is returned if this text has not been set.

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 codeDescription
S_OK

The method succeeded.

E_POINTER

longDescription is NULL.

 

Remarks

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

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

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

See also

IXpsOMCanvas
XPS Document Errors
XML Paper Specification

 

 

Community Additions

ADD
Show:
© 2015 Microsoft