ITextRange::GetText-Methode (tom.h)

Artikel
08/26/2023

Ruft den Nur-Text in diesem Bereich ab. Die Text-Eigenschaft ist die Standardeigenschaft der ITextRange-Schnittstelle .

Syntax

HRESULT GetText(
  BSTR *pbstr
);

Parameter

pbstr

Typ: BSTR*

Der Text.

Rückgabewert

Typ: HRESULT

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Wenn die Methode fehlschlägt, gibt sie einen der folgenden Fehlercodes zurück. Weitere Informationen zu COM-Fehlercodes finden Sie unter Fehlerbehandlung in COM.

Rückgabecode	Beschreibung
E_INVALIDARG	pbstr ist NULL.
E_OUTOFMEMORY	Unzureichender Arbeitsspeicher, um den Text zu speichern.

Hinweise

Die ITextRange::GetText-Methode gibt den Nur-Text im Bereich zurück. Die Text-Eigenschaft ist die Standardeigenschaft für ITextRange; Dies bedeutet, dass es automatisch für einen Bereich aufgerufen wird, wie im folgenden Beispiel für Microsoft Visual Basic for Applications (VBA) gezeigt.

print range

In einigen der folgenden Beispiele wird diese Tatsache verwendet. Die ITextRange::SetText-Methode ersetzt bstr durch den Bereichstext. Für die Verarbeitung eines einzelnen Zeichens ist die Char-Eigenschaft effizienter als die Text-Eigenschaft und erfordert keine Erstellung eines einzelnen Zeichenbereichs zum Speichern eines Zeichens. Wenn der Bereich degeneriert ist, können Sie mit der Text-Eigenschaft problemlos Text einfügen. Sie können auch den Text in einem Bereich löschen, wie in den folgenden VBA-Beispielen gezeigt.

range.delete

range = ""

Sie können die Text-Eigenschaft verwenden, um Nur-Text von einem Ort an einen anderen zu kopieren, indem Sie einfach einen Bereich gleich einem anderen festlegen. (Dies unterscheidet sich erheblich von der Duplicate-Eigenschaft . Weitere Informationen finden Sie unter ITextRange::GetDuplicate). In der folgenden Microsoft Visual Basic-Beispielanweisungen wird der Text im Bereich1 auf den text in range2 festgelegt.

range1 = range2 ' Replace range1's text by range2's

Die Bereiche können in verschiedenen Geschichten oder sogar in verschiedenen Anwendungen sein. Sie impliziert jedoch das Kopieren des Texts zuerst in einen BSTR und dann von dieser Zeichenfolge an den Zielspeicherort. Bei großen Textmengen können die Methoden ITextRange::Copy und ITextRange::P aste schneller sein, da sie die Kopie direkt von Quelle zu Ziel und in jedem format ausführen können, das von Quelle und Ziel unterstützt wird.

Der von der Text-Eigenschaft zurückgegebene Text wird in Unicode angegeben. Die Absatzendemarke kann je nach Originaldatei durch 0x2029 (Unicode-Absatztrennzeichen) oder durch Wagenrücklauf/Zeilenvorschub (CR/LF) (0xd, 0xa) oder allein durch einen Wagenrücklauf angegeben werden. Microsoft Word verwendet einen Wagenrücklauf allein, es sei denn, es liest eine andere Auswahl aus einer Datei, der Zwischenablage oder einem IDataObject ein. Der Platzhalter für ein eingebettetes Objekt wird durch das Sonderzeichen WCH_EMBEDDING angegeben, das den Unicode-Wert 0xFFFC hat.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	tom.h
DLL	Msftedit.dll