ImmNotifyIME
This function notifies the IME about changes to the status of the input context.
BOOL ImmNotifyIME(
HIMC hIMC,
DWORD dwAction,
DWORD dwIndex,
DWORD dwValue);
Parameters
hIMC
[in] Handle to the input context.dwAction
[in] Specifies the notification code. It is one of the following values:Value Description NI_CHANGECANDIDATELIST An application changed the current selected candidate; dwIndex is an index of a candidate list to be selected and dwValue is not used. NI_CLOSECANDIDATE An application directs the IME to close a candidate list; dwIndex is the index of the list to close; dwValue is not used. The IME sends a IMN_CLOSECANDIDATE message to the application if it closes the list. NI_COMPOSITIONSTR An application directs the IME to carry out an action on the composition string; dwValue is not used and dwIndex can be CPS_CANCEL, CPS_COMPLETE, CPS_CONVERT, or CPS_REVERT. NI_IMEMENUSELECTED An application directs the IME to allow the application to handle the specified menu; dwIndex is the ID of the menu and dwValue is an application-defined value for that menu item. NI_OPENCANDIDATE An application directs the IME to open a candidate list; dwIndex is the index of the list to open; dwValue is not used. The IME sends a IMN_OPENCANDIDATE message to the application if it opens the list. NI_SELECTCANDIDATESTR An application selected one of candidates; dwIndex is an index of a candidate list to be selected and dwValue is an index of a candidate string in the selected candidate list. NI_SETCANDIDATE_PAGESIZE The dwIndex parameter specifies the candidate list to be changed and must have a value in the range 0 to 31. NI_SETCANDIDATE_PAGESTART The dwIndex parameter specifies the candidate list to be changed and must have a value in the range 0 to 31. dwIndex
[in] Specifies the index of a candidate list or, if dwAction is NI_COMPOSITIONSTR, one of the following values:Value Description CPS_CANCEL Clear the composition string and set the status to no composition string. CPS_COMPLETE Set the composition string as the result string. CPS_CONVERT Convert the composition string. CPS_REVERT Cancel the current composition string and revert to the unconverted string. dwValue
[in] Specifies the index of a candidate string or not used, depending on the value of the dwAction parameter.
Return Values
Nonzero indicates success. Zero indicates failure.
Requirements
| Runs on | Versions | Defined in | Include | Link to |
|---|---|---|---|---|
| Windows CE OS | 2.10 and later (Japanese version 1.0 and later) | Imm.h | Coreimm.lib |
Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
IMN_CLOSECANDIDATE, IMN_OPENCANDIDATE
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.