ImmNotifyIME

The ImmNotifyIME 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. This parameter can be one of the following values.

Value	Meaning
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 command 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. See dwIndex for more information.
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 command 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 application changes the page size of a candidate list. The dwIndex parameter specifies the candidate list to be changed and must have a value in the range 0 to 3. The dwValue parameter is the new page size.
NI_SETCANDIDATE_PAGESTART	The application changes the page starting index of a candidate list. The dwIndex parameter specifies the candidate list to be changed and must have a value in the range 0 to 3. The dwValue parameter is the new page start index.

dwIndex

[in] Specifies the index of a candidate list or, if dwAction is NI_COMPOSITIONSTR, this parameter can be one of the following values.

Value	Meaning
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 set the composition string to be 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

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.
  Library: Use Imm32.lib.

See Also

Input Method Editor Overview, Input Method Editor Functions, , IMN_CLOSECANDIDATE, IMN_OPENCANDIDATE