IWordSink::PutBreak method

Puts a break after the preceding word.

Syntax

HRESULT PutBreak(
  [in] WORDREP_BREAK_TYPE breakType
);

Parameters

breakType [in]

A value from WORDREP_BREAK_TYPE that indicates the type of break that the WordSink inserts after the preceding word. Each break occupies a unique position in the index. Therefore, inserting breaks between words changes the relative distance between words.

Return value

This method can return one of these values.

Return code	Description
S_OK	The operation was completed successfully.

 

Remarks

The IWordSinkPutWord and IWordSink::PutAltWord methods automatically insert an end-of-word break (EOW, indicated by the WORDREP_BREAK_EOW element of the WORDREP_BREAK_TYPE enumerated type) after each word. Call the PutBreak method to insert a break type other than end of word. This method does not change the source text buffer (pSourceText) or increment the character count (cwc). However, it does increment the current position in the index and affects query results.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Search.h

See also

IWordSink