ITextRangeProvider::GetText-Methode (uiautomationcore.h)

Artikel
08/26/2023

Ruft den reinen Text des Bereichs ab.

Syntax

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

Parameter

[in] maxLength

Typ: int

Die maximale Länge der zurückzugebenden Zeichenfolge. Verwenden Sie –1, wenn keine Grenze erforderlich ist.

[out, retval] pRetVal

Typ: BSTR*

Empfängt den Nur-Text des Textbereichs, der möglicherweise mit der angegebenen maximalen Länge abgeschnitten wird. Dieser Parameter wird nicht initialisiert übergeben.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

ITextRangeProvider::GetText ruft sowohl ausgeblendeten als auch sichtbaren Text ab.

Wenn maxLength größer als die Länge der Textspanne des Aufrufers ist, ist die zurückgegebene Zeichenfolge der reine Text des Textbereichs.

ITextRangeProvider::GetText ist nicht von der Reihenfolge der Endpunkte im Textfluss betroffen. Es gibt immer den Text zwischen den Anfangs- und Endpunkten des Textbereichs in der Reihenfolge des logischen Textflusses zurück.

Anforderungen


Unterstützte Mindestversion (Client)	Windows XP [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	uiautomationcore.h (include UIAutomation.h)