IWordSink::EndAltPhrase method

Indicates the end of the final phrase in a sequence of alternative phrases that a word breaker generates during index time.

Syntax

HRESULT EndAltPhrase();

Parameters

This method has no parameters.

Return value

This method can return one of these values.

Return code Description
WBREAK_E_QUERY_ONLY
EndAltPhrase is called during query time.

 

Remarks

IWordBreaker implementations call IWordSink::EndAltPhrase from the IWordBreaker::BreakText method to terminate a sequence of alternative phrases. The IWordSink::StartAltPhrase method is called to indicate the end of one phrase and the beginning of another in a sequence of phrases. Only the last phrase in a sequence is terminated with a call to EndAltPhrase.

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