Edit

ITfCandidateListUIElement::GetSelection method (msctf.h)

  • Article

The ITfCandidateListUIElement::GetSelection method returns the current selection of the candidate list.

Syntax

HRESULT GetSelection(
  [out] UINT *puIndex
);

Parameters

[out] puIndex

[out] A pointer to receive an index of the current selected candidate string.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_FAIL
 An unspecified error occurred.
E_INVALIDARG
 One or more parameters are 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 msctf.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional