The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfKeystrokeMgr::AdviseKeyEventSink method

Syntax

C++


HRESULT AdviseKeyEventSink(
  [in] TfClientId      tid,
  [in] ITfKeyEventSink *pSink,
  [in] BOOL            fForeground
);

Parameters

tid [in]: Identifier of the client that owns the key event sink. This value is obtained by a previous call to ITfThreadMgr::Activate.
pSink [in]: Pointer to a ITfKeyEventSink interface.
fForeground [in]: Specifies if this key event sink is made the foreground key event sink. If this is TRUE, this key event sink is made the foreground key event sink. Otherwise, this key event sink does not become the foreground key event sink.

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.
CONNECT_E_ADVISELIMIT	The client identified by tid has a key event sink installed.

Remarks

The foreground key event sink receives all keyboard events. A non-foreground key event sink only receives preserved keys and key events that occur over text that marked owned by the client identifier.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps \| Windows Store apps]
Minimum supported server	Windows 2000 Server [desktop apps \| Windows Store apps]
Redistributable	TSF 1.0 on Windows 2000 Professional
Header	Msctf.h
IDL	Msctf.idl
DLL	Msctf.dll