Edit

Share via

ITfCandidateList::GetCandidate method (ctffunc.h)

  • Article

Obtains a specific candidate string object.

Syntax

HRESULT GetCandidate(
  [in]  ULONG              nIndex,
  [out] ITfCandidateString **ppCand
);

Parameters

[in] nIndex

Specifies the zero-based index of the candidate string to obtain.

[out] ppCand

Pointer to an ITfCandidateString interface pointer that receives the candidate string object. The caller must release this interface when it is no longer required.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_FAIL
 nIndex is invalid.
E_INVALIDARG
 ppCand is invalid.
E_OUTOFMEMORY
 A memory allocation failure occurred.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header ctffunc.h
DLL Tiptsf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfCandidateList

ITfCandidateString