IXpsOMCanvas::GetAccessibilityShortDescription メソッド (xpsobjectmodel.h)
オブジェクトの内容の短いテキスト説明を取得します。 このテキストは、オブジェクトを記述するためにアクセシビリティ クライアントによって使用されます。
構文
HRESULT GetAccessibilityShortDescription(
[out, retval] LPWSTR *shortDescription
);
パラメーター
[out, retval] shortDescription
オブジェクトの内容の短いテキストの説明。 この説明が設定されていない場合は、 NULL ポインターが返されます。
戻り値
このメソッドは HRESULT を返します。 使用可能な値には、次の表に含まれる値が含まれますが、これらに限定されません。 この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメント エラー」を参照してください。
| リターン コード | 説明 |
|---|---|
|
メソッドが成功しました。 |
|
shortDescription は NULL です。 |
注釈
このメソッドによって返される プロパティは、ドキュメント マークアップの Canvas 要素の 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 |