ITextInputPanel::Advise method

[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

EventSink [in]

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 codeDescription
S_OK

Success.

E_FAIL

An unspecified error occurred.

 

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

End of client support

Windows 7

End of server support

None supported

Header

Peninputpanel.h (also requires Peninputpanel_i.c)

DLL

Tiptsf.dll

See also

ITextInputPanel Interface
ITextInputPanel::Unadvise Method
EventMask Enumeration

 

 

Show: