ITextInputPanel::Advise method (peninputpanel.h)

[ITextInputPanel is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use IInputPanelConfiguration.

]

Establishes an advisory connection between the Tablet PC Input Panel and the specified sink object.

Syntax

HRESULT Advise(
  [in] ITextInputPanelEventSink *EventSink,
       DWORD                    EventMask
);

Parameters

[in] EventSink

Reference to the sink object to receive event notifications from the Input Panel.

EventMask

A bitwise value of the EventMask Enumeration, indicating the events of interest.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_FAIL	An unspecified error occurred.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	peninputpanel.h
DLL	Tiptsf.dll

See also

EventMask Enumeration

ITextInputPanel Interface

ITextInputPanel::Unadvise Method