GetAlternateWordsHRCRESULT

2.0

Returns alternative word interpretations of a previous result. (Not supported in Japanese version.)

int GetAlternateWordsHRCRESULT( HRCRESULT hrcresult, UINT iSyv, UINT cSyv, LPHRCRESULT rghrcresults, UINT cResults )

Parameters
hrcresult

Handle of a results object.

iSyv

Index of the first of a span of symbols within the results object.

cSyv

The number of symbols in the original result, starting at iSyv, for which alternative words are required.

rghrcresults

Address of a result array. This address cannot be NULL.

cResults

The size of the rghrcresults array in results. This parameter must be greater than 0.

Return Value
Returns the number of results actually provided, if successful. This can be less than the space allocated in rghrcresults, and may be 0; otherwise, returns one of the following negative values:

Constant	Description
HRCR_ERROR	Invalid parameter or other error.
HRCR_MEMERR	Insufficient memory.
HRCR_UNSUPPORTED	The recognizer does not support this function.

Comments
GetAlternateWordsHRCRESULT provides alternative word interpretations of a previous result. The alternatives returned are strongly coerced to words in the recognizer's dictionary, if enabled, and the word list, if any, of the HRC that processed the results.

The span of symbols defined by iSyv and cSyv need not fall on word boundaries. However, the recognizer returns only a single word per result. It is the application's responsibility to ensure that embedding a full word within other symbols makes sense. (The application can also choose to let the user make that decision.) For example, finding alternatives for "polce" in the phrase "pig-in-a-polce" could legitimately return "poke" as an alternative, but alternatives for "kef" in "markefplace" would probably be meaningless.