GetBoxMappingHRCRESULT  

2.0     

Returns the box indices for a range of symbols.

int GetBoxMappingHRCRESULT( HRCRESULT hrcresult, UINT iSyv, UINT cSyv, UINT FAR * rgi )

Parameters

hrcresult

Handle of a results object.

iSyv

Index of the first symbol of interest in the results object.

cSyv

The number of symbols following iSyv for which box indices are required. Note that the array rgi must be large enough to accommodate this many items of size UINT. A value of 0 is allowed, in which case the function simply returns 0.

rgi

Address of an index array. The array must be large enough to store cSyv indices. This address cannot be NULL.

Return Value

Returns the number of indices actually retrieved, if successful. This can be less than the space allocated in rgi if iSyv indexes an element near the end of the results array, and is 0 if iSyv indexes a nonexistent element; 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

GetBoxMappingHRCRESULT is typically used with boxed input established by SetGuideHRC3BE5AG5. If no guide structure has been set, the recognizer will return HRCR_ERROR.

It is possible to allocate a small buffer in rgi and call GetBoxMappingHRCRESULT repeatedly, incrementing the index iSyv each time by the number of indices returned in the previous call until GetBoxMappingHRCRESULT returns 0.

See Also

GetResultsHRC