GetResultsHRC
2.0
Retrieves
results from a recognition context HRC. A recognizer must export this
function.
int GetResultsHRC( HRC hrc, UINT uType,
LPHRCRESULT rghrcresults, UINT cResults )
Parameters
hrc
Handle to the
HRC object.
uType
Specifies the
type of expected results. This can be one of the following values:
|
Constant |
Description |
|
GRH_ALL |
Return all
results. |
|
GRH_GESTURE |
Return
results of type gesture only. |
|
GRH_NONGESTURE |
Return all
results not of type gesture. |
rghrcresults
Address of an
array of HRCRESULT objects.
cResults
The size of
the rghrcresults array, in objects. The actual size in bytes can be
calculated by multiplying cResults by the size of HRCRESULT. This
parameter must be greater than 0.
Return Value
Returns the
actual number of results returned if successful. This can be 0; otherwise, returns
one of the following negative values:
|
Constant |
Description |
|
HRCR_ERROR |
Invalid
parameter or other error. |
|
HRCR_HOOKED |
A hook
preempted the result. |
|
HRCR_MEMERR |
Insufficient
memory. |
Comments
The actual
number of results returned by this function may be less than the number
specified by cResults. It is also less than or equal to the count
specified at the creation of hrc by the cMaxResults parameter in SetMaxResultsHRC, regardless of the size of
the rghrcresults array.
A return
value of 0 indicates that the recognizer was not able to recognize any of the
input, even if coerced by a word list set into the HRC. A recognizer
should never return a result consisting entirely of SYV_UNKNOWN symbols.
The calling
application must explicitly destroy each valid result using DestroyHRCRESULT. However, if the return
value is 0 or negative, the contents of the rghrcresults array are
undefined (though not NULL) and DestroyHRCRESULT must not be called.
See Also