Edit

ITfCandidateList::EnumCandidates method (ctffunc.h)

  • Article

Obtains an enumerator that contains all the candidate string objects in the candidate list.

Syntax

HRESULT EnumCandidates(
  [out] IEnumTfCandidates **ppEnum
);

Parameters

[out] ppEnum

Pointer to an IEnumTfCandidates interface pointer that receives the enumerator 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_INVALIDARG
 ppEnum 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

IEnumTfCandidates

ITfCandidateList