ISoftKbd::AdviseSoftKeyboardEventSink method

The ISoftKbd::AdviseSoftKeyboardEventSink method installs a soft keyboard event sink to handle OnKeySelection notifications from the soft keyboard.

Syntax

HRESULT AdviseSoftKeyboardEventSink(
  [in]  DWORD    dwKeyboardId,
  [in]  REFIID   riid,
  [in]  IUnknown *punk,
  [out] DWORD    *pdwCookie
);

Parameters

dwKeyboardId [in]

Identifier of the soft keyboard.

riid [in]

Interface identifier for the sink interface.

punk [in]

Pointer to IUnknown for the sink interface specified by riid. This parameter cannot be set to NULL.

pdwCookie [out]

Pointer to the buffer in which this method retrieves the soft keyboard "cookie" used for connection to the client. The cookie must be unique for each connection.

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.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Redistributable	TSF 1.0 on Windows 2000 Professional
Header	Softkbdc.h
IDL	Softkbd.idl
DLL	Softkbd.dll

See also

ISoftKbd

ISoftKbd::UnadviseSoftKeyboardEventSink