TEXT_SOURCE Structure
Contains information about text for the word breaker to process.
Syntax
typedef struct tagTEXT_SOURCE{ PFNFILLTEXTBUFFER pfnFillTextBuffer; WCHAR const * awcBuffer; ULONG iEnd; ULONG iCur; } TEXT_SOURCE;
Members
- pfnFillTextBuffer
Pointer to a function, PFNFILLTEXTBUFFER. The PFNFILLTEXTBUFFER function refills the awcBuffer with text from the source document.- awcBuffer
Pointer to a buffer that contains text from the source document for the word breaker to parse.- iEnd
Position of the last character in awcBuffer.- iCur
Position of the first character in awcBuffer.
Remarks
Windows Search populates elements of this structure when the word breaker is invoked and initialized. IWordBreaker::BreakText gets a pointer to TEXT_SOURCE and calls PFNFILLTEXTBUFFER, the function pointed to by the pfnFillTextBuffer parameter, to refill awcBuffer until all text from the source is processed.
The PFNFILLTEXTBUFFER function returns an HRESULT that includes both filtering and word-breaking return values. The filtering return values are FILTER_E_NO_MORE_VALUES, FILTER_E_NO_TEXT, FILTER_E_NO_VALUES, FILTER_E_NO_MORE_TEXT, and FILTER_E_END_OF_CHUNKS. For more information about these return values, see Filter-Interface Values. The word-breaking return value is WBREAK_E_END_OF_TEXT. For more information about word-breaking return values, see Word-Breaking Values.
Structure Information
Header indexsrv.h Minimum operating systems Windows NT 4.0 with the Windows NT 4.0 Option Pack, Windows 2000
See Also