IWordSink::PutAltWord 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 an alternative word and its position in the WordSink.

Syntax

HRESULT PutAltWord(
  [in]       ULONG cwc,
  [in] const WCHAR *pwcInBuf,
  [in]       ULONG cwcSrcLen,
  [in]       ULONG cwcSrcPos
);

Parameters

• cwc [in]
  The number of characters in pwcInBuf.

• pwcInBuf [in]
  A pointer to a buffer that contains an alternative form of a word from the source text. This parameter is not modified by PutAltWord. You can pass the pTextSource parameter from IWordBreaker::BreakText as appropriate.

• cwcSrcLen [in]
  The number of characters in the source text buffer (indicated by the pTextSource parameter to IWordBreaker::BreakText) that correspond to the word contained in pwcInBuf.

• cwcSrcPos [in]
  The starting position of the word in pwcInBuf in the source text buffer (indicated by the pTextSource parameter to IWordBreaker::BreakText).

Return value

This method can return one of these values.

Remarks

PutAltWord puts an alternative form of a word in the WordSink. The word is put in the same position as the original word in the text source (pTextSource in IWordBreaker::BreakText). By default, PutAltWord terminates words with a WORDREP_BREAK_EOW break type from the WORDREP_BREAK_TYPE enumerated type.

Requirements

See also

IWordSink