Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
GetBestResultString Function |
Returns the best result string.
Syntax
[C++]
HRESULT WINAPI GetBestResultString(
HRECOCONTEXT hrc,
ULONG *pcSize,
WCHAR *pwcBestResult
);
Parameters
hrc
[in] Handle to the recognizer context.
pcSize
[in, out] On input, the number of characters the pwcBestResult buffer can hold. On output, the number of characters the pwcBestResult buffer contains. If pwcBestResult is NULL, the function returns the required size of the buffer that you use to allocate the pwcBestResult buffer.
pwcBestResult
[out] Recognition result. If the buffer is too small, the function truncates the string. The string is not NULL-terminated. To determine the required size of the buffer, set pwcBestResult to NULL; use pcSize to allocate the pwcBestResult buffer.
Return Value
| HRESULT value | Description |
|---|---|
| S_OK | Success. |
| TPC_S_TRUNCATED | The string is truncated to fit in the pwcBestResult buffer. |
| E_POINTER | One of the parameters is an invalid pointer. |
| E_FAIL | An unspecified error occurred. |
| E_UNEXPECTED | Unexpected parameter or property type. |
| TPC_E_NOT_RELEVANT | The recognizer context does not contain results. |