Edit

IPhraseSink::PutPhrase method (indexsrv.h)

  • Article

Puts a query-time phrase in the IPhraseSink object.

Syntax

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

Parameters

[in] pwcPhrase

A pointer to a buffer that contains a phrase.

[in] cwcPhrase

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 IWordBreaker::BreakText method of the IWordBreaker implementation. Phrases that the IPhraseSink object handles are used by Windows Search to expand the original query text.

Requirements

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

See also

IPhraseSink