ITfCandidateList::GetCandidate method

Syntax


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

Parameters

nIndex [in]

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

ppCand [out]

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.

ValueDescription
S_OK

The method was successful.

E_FAIL

nIndex is invalid.

E_INVALIDARG

ppCand is invalid.

E_OUTOFMEMORY

A memory allocation failure occurred.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Ctffunc.h

IDL

Ctffunc.idl

DLL

Tiptsf.dll

See also

ITfCandidateList
ITfCandidateString

 

 

Community Additions

ADD
Show:
© 2014 Microsoft