IFECommon

This is a global interface.

Interface id IID_IFECommon
Version 1.0

    IFECommon interface provides services which are common for different languages. Currently following services are available for apprications.

    IFECommon methods

    Description

    IsDEfaultIME Check if specified IME is already set to default IME
    SetDefaultIME Set MS-IME to default IME
    InvokeWordRegDialog Invoke Word Register Dialog Box
    InvokeDictToolDialog Invoke Dictionary Tools Dialog Box

Getting Information on IME

    A client uses this method to find out if IME specified by the class id is the default IME on a local machine. Name of IME is that gotten from Win32 keyboard layout API.

HRESULT IFECommon::IsDefaultIME

Parameters:

CHAR *szName Name of IME for the specified class id, can be NULL.
INT cszName Size of szName in bytes.

Return Values:

HRESULT
  • S_OK if this MS-IME is already the default IME
  • S_FALSE if this MS-IME is not the default IME
  • E_FAIL otherwise

Making MS-IME the Default IME

This method allows MS-IME to become the default IME in the keyboard layout. For example, if a client specifies CLSID_MSIME98_JAPANESE, this method sets MS-IME98 as the default IME.  This method only applies to MS-IME using the Input Method Manager(IMM) of the operating system.

HRESULT IFECommon::SetDefaultIME

Parameters:

VOID

Return Values:

HRESULT
  • S_OK on success
  • IFEC_S_ALREADY_DEFAULT if this MS-IME is already the default IME
  • E_FAIL otherwise

Invoking User Word Register Dialog

This method allows clients to invoke word register dialog that includes a dialog tab containing error and correction words. Chanterelle is the only client for IME98A. IME98 will have this method defined, but will not implement it.

typedef struct _IMEDLG

{

int cbIMEDLG; //size of this structure

HWND hwnd; //parent window handle

BYTE *szWord; //optional string

int nTabId; //specifies a tab in dialog

} IMEDLG;

HRESULT IFECommon::InvokeWordRegDialog

Parameters:

IMEDLG *imedlg contains parameters need.

Return Values:

HRESULT
  • S_OK on success
  • E_FAIL otherwise

Invoking Dictionary Tools Dialog

This method allows clients to invoke MSIME's dictionary tools dialog. Chanterelle is the only client for IME98A. IME98 will have this method defined, but will not implement it.

HRESULT IFECommon::InvokeDictToolDialog

Parameters:

IMEDLG *imedlg contains parameters need.

Return Values:

HRESULT
  • S_OK on success
  • E_FAIL otherwise