ITfFnBalloon::UpdateBalloon method (ctffunc.h)

Article
02/22/2024

Changes the style and text of a language bar balloon item.

Syntax

HRESULT UpdateBalloon(
  [in] TfLBBalloonStyle style,
  [in] const WCHAR      *pch,
  [in] ULONG            cch
);

Parameters

[in] style

Contains one of the TfLBBalloonStyle values that specifies the new balloon style.

[in] pch

Pointer to a WCHAR buffer that contains the new text for the balloon.

[in] cch

Contains the number of characters of the new text in pch.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_INVALIDARG	One or more parameters are invalid.

Remarks

The language bar balloon implementation should update its style and text by modifying the values returned from ITfLangBarItemBalloon::GetBalloonInfo and then call ITfLangBarItemSink::OnUpdate with TF_LBI_BALLOON to cause the language bar to obtain the updated information.

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	ctffunc.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional