ITextRangeProvider::GetText メソッド (uiautomationcore.h)

範囲のプレーンテキストを取得します。

構文

HRESULT GetText(
  [in]          int  maxLength,
  [out, retval] BSTR *pRetVal
);

[in] maxLength

型: int

返す文字列の最大長。制限が必要ない場合は、-1 を使用します。

[out, retval] pRetVal

種類: BSTR*

テキスト範囲のプレーンテキストを受け取ります。指定した最大長で切り捨てられる可能性があります。このパラメーターは初期化せずに渡されます。

種類: HRESULT

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

ITextRangeProvider::GetText は、非表示と表示の両方のテキストを取得します。

maxLength が呼び出し元のテキスト範囲の長さを超える場合、返される文字列はテキスト範囲のプレーンテキストになります。

ITextRangeProvider::GetText は、テキストフロー内のエンドポイントの順序の影響を受けられません。論理テキストフローの順序で、テキスト範囲の開始エンドポイントと終了エンドポイントの間のテキストが常に返されます。


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