Share via

IInputMethod::UserOptionsDlg (Compact 2013)

  • Article

3/28/2014

This method is implemented when the user requests that an input method (IM)-specific options dialog box be presented.

Syntax

HRESULT UserOptionsDlg( 
  HWND hwndParent
);

Parameters

  • hwndParent
    [in]Handle to the window that should be the parent of the dialog box window created by the IM.

Return Value

Return S_OK to indicate success. Return the appropriate HRESULT value to indicate failure.

Remarks

Through this method, the user can directly configure settings within the IM. This method differs significantly in context from the other methods in the IInputMethod interface for the following reasons:

  • It is called by the software-based input panel (SIP) control panel dialog box after instantiating a new instance of the IM; it is not called on the SIP thread.
  • It is called without other initialization methods, such as RegisterCallback or Select, being called first.
  • The current IM instance is unloaded immediately after calling UserOptionsDlg.

The User Options dialog box sets registry or other persistent configuration information for the IM. This information is used by the IM when it is selected into the SIP.

Requirements

Header

sip.h

Library

uuid.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

IInputMethod
IInputMethod::RegisterCallback
IInputMethod::Select