Edit

Share via

IEnumTfCandidates::Next method (ctffunc.h)

  • Article

Obtains, from the current position, the specified number of elements in the enumeration sequence.

Syntax

HRESULT Next(
  [in]  ULONG              ulCount,
  [out] ITfCandidateString **ppCand,
  [out] ULONG              *pcFetched
);

Parameters

[in] ulCount

Specifies the number of elements to obtain.

[out] ppCand

Pointer to an array of ITfCandidateString interface pointers that receives the requested objects. This array must be at least ulCount elements in size.

[out] pcFetched

Pointer to a ULONG value that receives the number of elements obtained. This value can be less than the number of items requested. This parameter can be NULL.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
S_FALSE
 The method reached the end of the enumeration before the specified number of elements were obtained.
E_INVALIDARG
 ppCand is invalid.

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 Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

IEnumTfCandidates

ITfCandidateString