ITfCandidateString::GetIndex method (ctffunc.h)

Syntax

HRESULT GetIndex(
  [out] ULONG *pnIndex
);

Parameters

[out] pnIndex

Pointer to a ULONG value that receives the zero-based index of the candidate string object within the candidate list.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.
E_INVALIDARG
pnIndex is invalid.

Requirements

   
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