Microsoft IME Application Interface

  • Article

 

August 2003

Microsoft Corporation

Summary: This document gives a brief overview of the Microsoft IME 2003, Japanese version API, in terms of functionality and API format. (2 printed pages)

Contents

What Is the Microsoft IME API?
Overview by Functionality
Overview by API Format

What Is the Microsoft IME API?

There are two ways to communicate between the Microsoft® Input Method Editor (IME) and applications:

  • Use the standard Microsoft Input Method Manager (IMM) APIs published in the Win32 SDK
  • Use the Microsoft IME native application interface exported from the IME itself

This document describes how applications can use the native interface to communicate with Microsoft IME directly. The need for such an application interface may arise for the following reasons:

  • An application requires the use of some Microsoft IME-specific functionality or to exchange information that is unavailable via IMM
  • An application requires the use of new features defined in an updated version of IMM, but the OS has the old version of IMM

Overview by Functionality

IME Active Dictionary Interface: The IImeActiveDict global interface allows vendors to develop a plug-in dictionary in any format.

IME Pad Interface: The IImePad, IImePadApplet global interfaces allow vendors to develop a "pluggable" input method with its own user interface. The WM_MSIME_SHOWIMEPAD message allows an application to control the IME Pad as a part of the IME interface. The IIMEFNIMEPad interface allows an application to invoke the IME Pad on the Common Text Framework.

Other Native Application Interfaces: Currently, there are four other global interfaces, namely IFECommon, IFELanguage, IFEDictionary, and IIMECheckDefaultInputProfile. In addition, a service object called CIMEShare allows multiple applications to share the same behavior and UI (IME undetermined string). Further, the WM_MSIME_ messages are defined to allow applications to use advanced features of Microsoft IME in synchrony with standard IMM messages, through the IME interface.

Overview by API Format

There are two types of application interfaces provided by the Microsoft IME:

All application interfaces are defined in one header file named MSIME.H. All string manipulation interfaces use the UNICODE character set.

Refer to Parts of Speech used by both interfaces.

The interfaces described in this document are supported by Microsoft IME 2003, Japanese version. Some have been supported since IME 98. Specification changes between versions are described with each new interface description.