ITextStoreAnchor::GetText-Methode (textstor.h)
Die ITextStoreAnchor::GetText-Methode gibt Informationen zu Text an einer angegebenen Ankerposition zurück. Diese Methode gibt den sichtbaren und ausgeblendeten Text zurück und gibt an, ob eingebettete Daten an den Text angefügt sind.
Syntax
HRESULT GetText(
[in] DWORD dwFlags,
[in] IAnchor *paStart,
[in] IAnchor *paEnd,
[out] WCHAR *pchText,
[in] ULONG cchReq,
[out] ULONG *pcch,
[in] BOOL fUpdateAnchor
);
Parameter
[in] dwFlags
Nicht verwendet; sollte null sein.
[in] paStart
Gibt die Startankerposition an.
[in] paEnd
Gibt die Endankerposition an. Wenn NULL, wird es so behandelt, als wäre es ein Anker, der sich ganz am Ende des Textstreams befindet.
[out] pchText
Gibt den Puffer an, der den Text empfangen soll. Darf nur NULL sein, wenn cchReq = 0.
[in] cchReq
Gibt die Größe des pchText-Puffers in Zeichen an.
[out] pcch
Empfängt die Anzahl der Zeichen, die in den pchText-Puffer kopiert wurden.
[in] fUpdateAnchor
Bei TRUE wird paStart direkt hinter dem letzten Zeichen, das in pchText kopiert wurde, neu positioniert.
Rückgabewert
Diese Methode kann einen dieser Werte zurückgeben.
| Wert | BESCHREIBUNG |
|---|---|
|
Die Methode wurde erfolgreich abgeschlossen. |
|
Die Methode konnte keinen gültigen Schnittstellenzeiger auf paStart und/oder paEnd abrufen. |
|
Die paStart - oder paEnd-Anker befinden sich außerhalb des Dokumenttexts. |
|
Der Aufrufer verfügt nicht über eine schreibgeschützte Sperre für das Dokument. |
Hinweise
Aufrufer, die diese Methode verwenden, müssen über eine schreibgeschützte Sperre für das Dokument verfügen, indem sie die ITextStoreAnchor::RequestLock-Methode aufrufen. Ohne schreibgeschützte Sperre schlägt die Methode fehl und gibt TF_E_NOLOCK zurück.
Anwendungen können die Rückgabewerte der Methode aus internen Gründen abschneiden.
Zum schnellen Scannen von Text mit mehreren GetText-Aufrufen verwendet ein Aufrufer fUpdateAnchor = TRUE.
Die tatsächliche Anzahl der kopierten Zeichen kann kleiner als cchReq sein, wenn die Anzahl der Zeichen zwischen paStart und paEnd kleiner als cchReq ist.
Das Verhalten von GetText wird nicht durch Regionsgrenzen beeinflusst, die durch den zurückgegebenen Text abgedeckt werden.
Anforderungen
| Unterstützte Mindestversion (Client) | Windows 2000 Professional [Desktop-Apps | UWP-Apps] |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [Desktop-Apps | UWP-Apps] |
| Zielplattform | Windows |
| Kopfzeile | textstor.h |
| DLL | Msctf.dll |
| Verteilbare Komponente | TSF 1.0 unter Windows 2000 Professional |