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)

另請參閱

概念

ITextProvider

ITextRangeProvider

參考

UI 自動化提供者概觀