Edit

ITfCandidateListUIElement::GetString method (msctf.h)

  • Article

The ITfCandidateListUIElement::GetString method returns the string of the index.

Syntax

HRESULT GetString(
  [in]  UINT uIndex,
  [out] BSTR *pstr
);

Parameters

[in] uIndex

[in] An index of the string to obtain.

[out] pstr

[out] A pointer to BSTR for the candidate string of the index.

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