IActiveIMMIME::NotifyIME Method

---

Notifies the IME about changes to the status of the input context.

Syntax

HRESULT NotifyIME(
    HIMC hIMC,
    DWORD dwAction,
    DWORD dwIndex,
    DWORD dwValue
);

Parameters

hIMC

[in] Handle to the input context.

dwAction

[in] Unsigned long integer value that contains the notification code.

dwIndex

[in] Unsigned long integer value that contains the index of a candidate list or, if dwAction is set to NI_COMPOSITIONSTR, one of the following values:

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] Unsigned long integer value that contains the index of a candidate string or is not used, depending on the value of the dwAction parameter.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

This method maps to the ImmNotifyIME function documented in the Microsoft® Platform Software Development Kit (SDK).