ITfLangBarItem::GetTooltipString method (ctfutb.h)

Obtains the text to be displayed in the tooltip for the language bar item.

Syntax

HRESULT GetTooltipString(
  [out] BSTR *pbstrToolTip
);

Parameters

[out] pbstrToolTip

Pointer to a BSTR value that receives the tooltip string for the language bar item. This string must be allocated using the SysAllocString function. The caller must free this buffer when it is no longer required by calling SysFreeString.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_INVALIDARG	pbstrToolTip is invalid.
E_NOTIMPL	The language bar item does not support tooltip text.
E_OUTOFMEMORY	A memory allocation failure occurred.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ctfutb.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional

See also

ITfLangBarItem

SysAllocString

SysFreeString