Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 3.29 KB

nf-uiautomationcore-itextrangeprovider-gettext.md

File metadata and controls

105 lines (73 loc) · 3.29 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:uiautomationcore.ITextRangeProvider.GetText
ITextRangeProvider::GetText (uiautomationcore.h)
Retrieves the plain text of the range.
GetText
GetText method [Windows Accessibility]
GetText method [Windows Accessibility]
ITextRangeProvider interface
ITextRangeProvider interface [Windows Accessibility]
GetText method
ITextRangeProvider.GetText
ITextRangeProvider::GetText
uiauto.uiauto_ITextRangeProvider_GetText
uiauto_ITextRangeProvider_GetText
uiautomationcore/ITextRangeProvider::GetText
winauto.uiauto_ITextRangeProvider_GetText
winauto\uiauto_ITextRangeProvider_GetText.htm
WinAuto
f3c5f0cc-15a5-4a13-b3be-355de6633c66
12/05/2018
GetText, GetText method [Windows Accessibility], GetText method [Windows Accessibility],ITextRangeProvider interface, ITextRangeProvider interface [Windows Accessibility],GetText method, ITextRangeProvider.GetText, ITextRangeProvider::GetText, uiauto.uiauto_ITextRangeProvider_GetText, uiauto_ITextRangeProvider_GetText, uiautomationcore/ITextRangeProvider::GetText, winauto.uiauto_ITextRangeProvider_GetText
uiautomationcore.h
UIAutomation.h
Windows
Windows XP [desktop apps \| UWP apps]
Windows Server 2003 [desktop apps \| UWP apps]
UIAutomationCore.idl
Windows
19H1
ITextRangeProvider::GetText
uiautomationcore/ITextRangeProvider::GetText
c++
APIRef
kbSyntax
COM
UIAutomationCore.h
ITextRangeProvider.GetText

ITextRangeProvider::GetText

-description

Retrieves the plain text of the range.

-parameters

-param maxLength [in]

Type: int

The maximum length of the string to return. Use -1 if no limit is required.

-param pRetVal [out, retval]

Type: BSTR*

Receives the plain text of the text range, possibly truncated at the specified maximum length. This parameter is passed uninitialized.

-returns

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

-remarks

ITextRangeProvider::GetText retrieves both hidden and visible text.

If maxLength is greater than the length of the text span of the caller, the string returned will be the plain text of the text range.

ITextRangeProvider::GetText will not be affected by the order of endpoints in the text flow; it will always return the text between the start and end endpoints of the text range in the logical text flow order.

-see-also

Conceptual

ITextProvider

ITextRangeProvider

Reference

UI Automation Providers Overview