IPhraseSink::PutPhrase method

[Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.]

Puts a query-time phrase in the PhraseSink.

Syntax

HRESULT PutPhrase(
  [in] const WCHAR *pwcPhrase,
  [in]       ULONG cwcPhrase
);

Parameters

  • pwcPhrase [in]
    A pointer to a buffer that contains a phrase.

  • cwcPhrase [in]
    The number of characters in pwcPhrase. There is no limit on the size of a query-time phrase.

Return value

This method can return one of these values.

Return code Description
S_OK

The operation was completed successfully.

PSINK_E_QUERY_ONLY

PutPhrase was called at index time instead of query time.

 

Remarks

PutPhrase is called by the BreakText method of the IWordBreaker implementation. Phrases that the PhraseSink object handles are used by the Indexing Service to expand the original query text.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

End of client support

Windows 7

End of server support

Windows Server 2008 R2

Header

Indexsrv.h

See also

IPhraseSink