IInkLineInfo::GetCandidate method (msinkaut.h)

Returns one recognition alternate from the recognition result list.

Syntax

HRESULT GetCandidate(
  [in]  UINT   nCandidateNum,
  [out] LPWSTR pwcRecogWord,
  [out] UINT   *pcwcRecogWord,
  [in]  DWORD  dwFlags
);

Parameters

[in] nCandidateNum

Zero-based index of the alternate list entry to retrieve.

[out] pwcRecogWord

Buffer in which to store the selected recognition alternate. If pwcRecogWord is NULL, the method does not attempt to retrieve the recognition alternate word.

[out] pcwcRecogWord

Passes the length of the pwcRecogWord buffer in Unicode characters, and returns the number of Unicode characters that were copied into the buffer.

[in] dwFlags

Not used.

Return value

This method can return one of these values.

Return code	Description
S_OK	The method succeeded.
E_FAIL	The nCandidateNum index is greater that the number of recognition alternates.
ERROR_MORE_DATA	The pwcRecogWord buffer is not large enough to accept the recognition alternate.

Remarks

If the pwcRecogWord parameter is null, the method does not attempt to retrieve the recognition alternate word, but only sets pwcRecogWord to the number of characters in the recognition alternate.

If the pwcRecogWord buffer is not large enough to contain the recognition alternate, then the pwcRecogWord buffer is filled with the first pwcRecogWord number of characters from the recognition alternate.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut.h
Library	InkObj.dll

See also

IInkLineInfo

SetCandidate Method