Edit

IFrameworkInputPane::Advise method (shobjidl_core.h)

  • Article

Registers the app's input pane handler object to receive notifications on behalf of a window when an event triggers the input pane. This method differs from AdviseWithHWND in that it references its window through an object that implements ICoreWindow.

Syntax

HRESULT Advise(
  [in]  IUnknown                   *pWindow,
  [in]  IFrameworkInputPaneHandler *pHandler,
  [out] DWORD                      *pdwCookie
);

Parameters

[in] pWindow

Type: IUnknown*

A pointer to the window (an object that implements ICoreWindow) for which the handler should listen for input pane events.

[in] pHandler

Type: IFrameworkInputPaneHandler*

An IFrameworkInputPaneHandler interface pointer to the handler instance for this app.

[out] pdwCookie

Type: DWORD*

A pointer to a value that, when this method returns successfully, receives a cookie for that can be used later to unregister the handler through the Unadvise method.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)

See also

IFrameworkInputPane

IFrameworkInputPane::AdviseWithHWND

IFrameworkInputPane::Unadvise