ITfLangBarMgr::AdviseEventSink method (ctfutb.h)

Article
02/22/2024

The ITfLangBarMgr::AdviseEventSink method advises a sink about a language bar event.

Syntax

HRESULT AdviseEventSink(
  [in] ITfLangBarEventSink *pSink,
  [in] HWND                hwnd,
  [in] DWORD               dwFlags,
  [in] DWORD               *pdwCookie
);

Parameters

[in] pSink

Sink object to advise about the event.

[in] hwnd

Reserved; must be NULL.

[in] dwFlags

Reserved; must be 0.

[in] pdwCookie

Pointer to an identifier for the connection.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_INVALIDARG	pSink is invalid.
E_FAIL	An unspecified error occurred.

Remarks

pdwCookie receives an identifier that should be passed to ITfLangBarMgr::UnadviseEventSink when the event sink is no longer required.

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