IInputMethod3::UserOptionsDlg (Compact 2013)
3/28/2014
Implement this method to display a dialog box that presents configurable options to a user, which are specific to the input method.
Syntax
HRESULT UserOptionsDlg(
HWND hwndParent
);
Parameters
- hwndParent
[in] Handle to the window that is the parent of the dialog box window that is created by the input method.
Return Value
Returns S_OK to indicate success; otherwise, returns the appropriate HRESULT value to indicate that it was not successful.
Remarks
This method provides a way for a user to directly configure settings within the input method. The following table describes how this method differs from the other methods in the IInputMethod3 interface.
IInputMethod3::UserOptionsDlg |
Other IInputMethod3 methods |
|---|---|
Called by the software-based input panel (SIP) control panel dialog box after instantiating a new instance of the input method. |
Called on the SIP thread. |
Called without other initialization methods, such as IInputMethod3::RegisterCallback2 or IInputMethod3::Select, which are called first. |
Initialization methods such as IInputMethod3::RegisterCallback or IInputMethod3::Select are called first. |
The current input method instance is unloaded immediately after calling IInputMethod3::UserOptionsDlg. |
The current input method instance is not immediately unloaded after calling the method. |
The User Options dialog box sets registry or other persistent configuration information for the input method. This information is used when the SIP loads the input method selected by a user from the SIP dialog box or the Input Panel.
Requirements
Header |
sip.h |
Library |
uuid.lib |
sysgen |
SYSGEN_SOFTKB |
See Also
Reference
IInputMethod3
IInputMethod3::Deselect
IInputMethod3::GetInfo
IInputMethod3::Hiding
IInputMethod3::InputContextChange
IInputMethod3::ReceiveSipInfo
IInputMethod3::RegisterCallback
IInputMethod3::RegisterCallback2
IInputMethod3::RegisterCallback3
IInputMethod3::Select
IInputMethod3::SetImData
IInputMethod3::SetIMMActiveContext
IInputMethod3::Showing