ITfCandidateString::GetIndex method

Syntax


HRESULT GetIndex(
  [out] ULONG *pnIndex
);

Parameters

pnIndex [out]

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.

ValueDescription
S_OK

The method was successful.

E_INVALIDARG

pnIndex is invalid.

 

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

ITfCandidateString
ITfCandidateList

 

 

Show: