IFilter::GetText

Retrieves text from the current chunk.

SCODE GetText(
  ULONG * pcwcBuffer,  //On entry, size of requested awcBuffer; on 
                       //exit, characters retrieved
  WCHAR * awcBuffer    //Text retrieved from current chunk
);
 

Parameters

pcwcBuffer

[in/out] On entry, the size of awcBuffer array in wide/Unicode characters. On exit, the number of Unicode characters written to awcBuffer.

awcBuffer

[out] Text retrieved from the current chunk.

Return Values

FILTER_E_NO_TEXT

The current chunk does not have a STAT_CHUNK flags value of CHUNK_TEXT.

FILTER_E_NO_MORE_TEXT

All of the text in the current chunk has been returned. Additional call to GetText should return this error until GetChunk has been called successfully, advancing to the next chunk.

FILTER_S_LAST_TEXT

As an optimization, the last call that returns text may return FILTER_S_LAST_TEXT, indicating that next call to GetText will return FILTER_E_NO_MORE_TEXT. This optimization can save calls by eliminating unnecessary calls to GetText.

Remarks

If the current chunk is too large for the awcBuffer array, more than one call to GetText may be required to retrieve all of the text in the current chunk. Each call to GetText retrieves text that immediately follows the text from the last call to GetText. The last character from one call can be in the middle of a word, and the first character in the next call would continue that word. Search engines must handle this situation.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in filter.h.

See Also

IFilter::GetValue, IFilter::GetChunk