IWordInfo::BreakText method

[This method is obsolete and is not supported on Windows Vista.]

Parses text to identify words and provides the results to the WordSink object.

Syntax

HRESULT BreakText(
  [in] TEXT_SOURCE *pTextSource,
  [in] IWordSink   *pWordSink,
  [in] DWORD       fBreakMode
);

Parameters

pTextSource [in]

A pointer to a TEXT_SOURCE structure that contains the Unicode text.

pWordSink [in]

A pointer to the WordSink object that receives and handles the words generated by this method. If this parameter is NULL, the method does not break the string into words.

fBreakMode [in]

The break mode. This parameter can be one of the following values.

Value	Meaning
IWORDINFO_BREAKTEXTMODE_DICTFORM 0x00000002	Word break the text string and pass the dictionary form of the words to the WordSink object.
IWORDINFO_BREAKTEXTMODE_SMARTSEL 0x00000001	Word break the text string and pass the words to the WordSink object.

 

Return value

This method returns one of the following values.

Return code	Description
S_OK	The operation succeeded. There is no more text available to refill the pTextSource buffer.
E_FAIL	The pTextSource parameter is NULL.

 

Remarks

Use the pfnFillTextBuffer member of the TEXT_SOURCE structure to replenish the source text. This method must handle all return values from the pfnFillTextBuffer callback function. If an error occurs, finish processing the text in the buffer before handling the error.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
End of client support	Windows XP
End of server support	Windows Server 2003
DLL	Msir3jp.dll

See also

IWordInfo

TEXT_SOURCE

WordInfo

WordSink