IFilter::GetText-Methode (filter.h)

  • Artikel

Hinweis

Der Indizierungsdienst wird ab Windows XP nicht mehr unterstützt und steht ab Windows 8 nicht mehr zur Verfügung. Verwenden Sie stattdessen Windows Search für die clientseitige Suche und Microsoft Search Server Express für die serverseitige Suche.

Ruft Text (Texttypeigenschaften) aus dem aktuellen Block ab, der den CHUNKSTATE-Enumerationswert CHUNK_TEXT aufweisen muss.

Syntax

SCODE GetText(
  [in, out] ULONG *pcwcBuffer,
  [out]     WCHAR *awcBuffer
);

Parameter

[in, out] pcwcBuffer

Beim Eintrag die Größe des awcBuffer-Arrays in Breit-/Unicode-Zeichen. Beim Beenden die Anzahl der Unicode-Zeichen, die in awcBuffer geschrieben wurden.

[out] awcBuffer

Text, der aus dem aktuellen Block abgerufen wird. Beenden Sie den Puffer nicht mit einem Zeichen. Verwenden Sie eine NULL-endende Zeichenfolge. Die NULL-Zeichenfolge darf die Größe des Zielpuffers nicht überschreiten.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Rückgabecode BESCHREIBUNG
S_OK
 Der Vorgang wurde erfolgreich abgeschlossen.
FILTER_E_NO_TEXT
Der Flags-Member der STAT_CHUNK-Struktur für den aktuellen Block hat keinen Wert von CHUNK_TEXT.
FILTER_E_NO_MORE_TEXT
Der gesamte Text im aktuellen Block wurde zurückgegeben. Zusätzliche Aufrufe der GetText-Methode sollten diesen Fehler zurückgeben, bis die IFilter::GetChunk-Methode erfolgreich aufgerufen wurde.
FILTER_S_LAST_TEXT
Als Optimierung kann der letzte Aufruf, der Text zurückgibt, FILTER_S_LAST_TEXT zurückgeben, was angibt, dass der nächste Aufruf der GetText-Methode FILTER_E_NO_MORE_TEXT zurückgibt. Diese Optimierung kann Zeit sparen, da unnötige Aufrufe von GetText vermieden werden.

Hinweise

Wenn der aktuelle Block für das awcBuffer-Array zu groß ist, kann mehr als ein Aufruf der GetText-Methode erforderlich sein, um den gesamten Text im aktuellen Block abzurufen. Jeder Aufruf der GetText-Methode ruft Text ab, der unmittelbar auf den Text aus dem letzten Aufruf der GetText-Methode folgt. Das letzte Zeichen eines Aufrufs kann sich in der Mitte eines Worts befindet, und das erste Zeichen im nächsten Aufruf würde dieses Wort fortsetzen. Suchmaschinen müssen diese Situation bewältigen.

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 filter.h

Weitere Informationen

CHUNKSTATE

Ifilter