Share via


IActiveIMMApp::NotifyIME method

Notifies the Input Method Editor (IME) about changes to the status of the input context.

Syntax

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

Parameters

hIMC [in]

A handle to the input context.

dwAction [in]

An unsigned long integer value that contains the notification code.

dwIndex [in]

An 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]

An 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 value otherwise.

Remarks

This method maps to the ImmNotifyIME function that is documented in the Windows Software Development Kit (SDK).

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Product

Internet Explorer 5.0

Header

Dimm.h

IDL

Dimm.idl

See also

IActiveIMMApp