ITfCandidateString::GetString method (ctffunc.h)

Obtains the text of the candidate string object.

Syntax

HRESULT GetString(
  BSTR *pbstr
);

Parameters

pbstr

Pointer to a BSTR value that receives the text of the candidate string object. The caller must release this memory using SysFreeString when it is no longer required.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.
E_INVALIDARG
pbstr is invalid.
E_OUTOFMEMORY
A memory allocation failure occurred.

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

ITfCandidateString

SysFreeString