IUIAutomationTextPattern2::GetCaretRange メソッド (uiautomationclient.h)

テキストベースのコントロールに属するキャレットの位置にある長さ 0 のテキスト範囲を取得します。

構文

HRESULT GetCaretRange(
  [out, retval] BOOL                   *isActive,
  [out, retval] IUIAutomationTextRange **range
);

[out, retval] isActive

種類: BOOL*

キャレットを含むテキストベースのコントロールにキーボードフォーカスがある場合は TRUE、それ以外の場合 は FALSE。

[out, retval] range

テキストベースのコントロールに属するキャレットの現在の位置を表すテキスト範囲を受け取ります。

種類: HRESULT

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

isActive パラメーターが FALSE の場合、テキストベースのコントロールに属するキャレットがシステムキャレットと同じ場所にない可能性があります。

このメソッドは、クライアントがテキストベースのコントロールに属するキャレットの外接する四角形を検索したり、キャレットの近くのテキストを検索したりするために使用できるテキスト範囲を取得します。

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	uiautomationclient.h (UIAutomation.h を含む)