ITextProvider::GetSelection メソッド (uiautomationcore.h)

テキストベースのコントロールで現在選択されているテキストを表すテキスト範囲のコレクションを取得します。

構文

HRESULT GetSelection(
  [out, retval] SAFEARRAY **pRetVal
);

[out, retval] pRetVal

種類: SAFEARRAY**

選択したテキスト範囲ごとに 1 つずつ、テキスト範囲の ITextRangeProvider インターフェイスへのポインターの配列のアドレスを受け取ります。このパラメーターは初期化せずに渡されます。

型: HRESULT

このメソッドは、成功すると S_OK を返します。そうでない場合は、HRESULT エラーコードを返します。

テキストの選択をサポートする UI オートメーションプロバイダーの場合、プロバイダーはこのメソッドを実装し、 ITextProvider::SupportedTextSelection 値も返す必要があります。

コントロールに選択したテキストのスパンが 1 つだけ含まれている場合、 pRetVal 配列には 1 つのテキスト範囲が含まれている必要があります。

コントロールにテキストの挿入ポイントが含まれているが、テキストが選択されていない場合、 pRetVal 配列には、テキスト挿入ポイントの位置にある縮退した (空の) テキスト範囲が含まれている必要があります。

コントロールに選択したテキストが含まれていない場合、またはコントロールにテキスト挿入ポイントが含まれていない場合は、 pRetVal を NULL に設定します。


サポートされている最小のクライアント	Windows XP [デスクトップアプリ \| UWP アプリ]
サポートされている最小のサーバー	Windows Server 2003 [デスクトップアプリのみ \| UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	uiautomationcore.h (UIAutomation.h を含む)