ITextStoreACP::GetText-Methode (textstor.h)

Artikel
08/26/2023

Die ITextStoreACP::GetText-Methode gibt Informationen zu Text an einer angegebenen Zeichenposition 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]  LONG       acpStart,
  [in]  LONG       acpEnd,
  [out] WCHAR      *pchPlain,
  [in]  ULONG      cchPlainReq,
  [out] ULONG      *pcchPlainRet,
  [out] TS_RUNINFO *prgRunInfo,
  [in]  ULONG      cRunInfoReq,
  [out] ULONG      *pcRunInfoRet,
  [out] LONG       *pacpNext
);

Parameter

[in] acpStart

Gibt die Startzeichenposition an.

[in] acpEnd

Gibt die Endzeichenposition an. Wenn dieser Parameter -1 ist, geben Sie den gesamten Text im Textspeicher zurück.

[out] pchPlain

Gibt den Puffer an, der die Nur-Text-Daten empfangen soll. Wenn dieser Parameter NULL ist, muss der cchPlainReq-Parameter 0 sein.

[in] cchPlainReq

Gibt die Anzahl von Nur-Text-Zeichen an, die an die -Methode übergeben werden.

[out] pcchPlainRet

Empfängt die Anzahl der Zeichen, die in den Nur-Text-Puffer kopiert wurden. Dieser Parameter darf nicht NULL sein. Verwenden Sie einen Parameter, wenn keine Werte erforderlich sind.

[out] prgRunInfo

Empfängt ein Array von TS_RUNINFO Strukturen. Darf nur NULL sein, wenn cRunInfoReq = 0.

[in] cRunInfoReq

Gibt die Größe des Textausführungspuffers in Zeichen an.

[out] pcRunInfoRet

Empfängt die Anzahl TS_RUNINFO Strukturen, die in den Textausführungspuffer geschrieben wurden. Dieser Parameter darf nicht NULL sein.

[out] pacpNext

Empfängt die Zeichenposition des nächsten ungelesenen Zeichens. Kann nicht NULL sein.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
TF_E_INVALIDPOS	Die acpStart- oder acpEnd-Parameter befinden sich außerhalb des Dokumenttexts.
TF_E_NOLOCK	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 ITextStoreACP::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 auch aus internen Gründen abschneiden. Aufrufer sollten die Rückgabezeichen und die Anzahl der Textausführungen sorgfältig untersuchen, um die erforderlichen Rückgabewerte abzurufen. Wenn die Rückgabewerte unvollständig sind, rufen Sie die Methode wiederholt auf, bis die Rückgabewerte abgeschlossen sind.

Der Aufrufer kann nur Nur-Text anfordern, indem der Parameter cRunInfoReq auf 0 und der prgRunInfo-Parameter auf NULL festgelegt wird. Der Aufrufer kann nur Textausführungsdaten anfordern, indem der Parameter cchPlainReq auf 0 und der parameter pchPlain auf NULL festgelegt wird. Der Aufrufer muss jedoch weiterhin gültige Werte ungleich NULL für pcchPlainRet bereitstellen, auch wenn dieser Parameter nicht verwendet wird.

Wenn acpEnd -1 ist, sollte es so behandelt werden, als ob er am Ende des Datenstroms festgelegt ist. Andernfalls ist sie größer oder gleich 0.

Beim Beenden sollte pacpNext auf die Zeichenposition des nächsten Zeichens im Stream festgelegt werden, auf das nicht durch die Rückgabewerte verwiesen wird. Ein Aufrufer würde dies verwenden, um Text mit mehreren ITextStoreACP::GetText-Aufrufen schnell zu scannen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	textstor.h
DLL	Msctf.dll
Verteilbare Komponente	TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

Itextstoreacp

ITextStoreACP::RequestLock

Manager-Rückgabewerte

TS_RUNINFO

Freigeben über