IXpsOMPath::GetAccessibilityShortDescription メソッド (xpsobjectmodel.h)

オブジェクトの内容の短いテキスト説明を取得します。この説明は、オブジェクトを記述するためにアクセシビリティクライアントによって使用されます。

構文

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

[out, retval] shortDescription

オブジェクトの内容の短いテキスト説明。このテキストが設定されていない場合は、 NULL ポインターが返されます。

このメソッドは HRESULT を返します。使用可能な値には、次の表に示す値が含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメントエラー」を参照してください。

リターンコード	説明
S_OK	メソッドが成功しました。
E_POINTER	shortDescription は NULL です。

shortDescription で返される値は、ドキュメントマークアップの Path 要素の AutomationProperties.Name 属性の値です。

このメソッドは、 shortDescription で返される文字列で使用されるメモリを割り当てます。 shortDescription が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放します。

要件	値
サポートされている最小のクライアント	Windows 7、Windows Vista SP2 および Windows Vista 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	xpsobjectmodel.h