IFEDictionary

August 2003

Microsoft Corporation

Summary: This document describes the IFEDictionary interface for the Microsoft IME 2003, Japanese version. The IFEDictionary interface allows clients to access a Microsoft IME user dictionary. (12 printed pages)

Contents

Data Structures
Creating an IFEDictionary Instance
Operating the Dictionary File Object
Getting and Registering Words

This is a global interface.

Interface ID: IID_IFEDictionary
Version: 1.0

Note   Regarding the usage of this API: This API is intended to enable your applications to access and use the data contained in the Microsoft® IME dictionaries (including personal names & geographical names dictionaries) or user dictionary, and you can develop and sell such applications, provided that: 1) You do not create an application that accesses a dictionary that is not a Microsoft IME dictionary through this API, and 2) you do not dump, copy, and distribute the dictionaries' data contained in the Microsoft IME. You must use the API only for the purpose of developing applications for users who already have the Microsoft IME.

Data Structures

WORD Descriptor—IMEWRD

typedef struct _IMEWRD {
    WCHAR *pwchReading;
    WCHAR *pwchDisplay;
    union {
        ULONG ulPos;
        struct {
            WORD nPos1; //hinshi
            WORD nPos2; //extended hinshi
        };
    };
    ULONG rgulAttrs[2]; //attributes
    INT cbComment; //size of user comment
    IMEUCT uct; //type of user comment
    VOID *pvComment; //user comment
} IMEWRD, *PIMEWRD;

User Comment Type—IMEUCT

typedef enum
{
IFED_UCT_NONE,
IFED_UCT_STRING_SJIS,
IFED_UCT_STRING_UNICODE,
IFED_UCT_USER_DEFINED,
IFED_UCT_MAX,
} IMEUCT;

Notes on User Comment

IMEUCT specifies the type of user comment.IFED_UCT_STRING_SJISis a string in Shift JIS format andIFED_UCT_STRING_UNICODEis a string in Unicode format. If a string is null-terminated, the size of data must include the last null character. IFED_UCT_USER_DEFINED means a client can register a word of this type with User Comment and use it for whatever reason the client may have. The IME kernel will not use a word of this type during morphological analysis. When IMEWRD structure is returned via GetNextWord, the pvComment field will be set to NULL andcbCommentwill be zero if there are no user comments for that word. Otherwise, the IMEUCT field specifies the type of user comment. ThepvCommentis allocated by IFEDictionary object. The buffer size is the actual data size (cbComment) plus two, and the last two bytes are set to zero. This allows non-zero-terminated strings to be made zero-terminated without copying the strings to another location with a bigger buffer. The client must free the pvComment buffer.

Dictionary Header—IMESHF

typedef struct {
    WORD cbShf; //size of SHF
    WORD verDic; //user specified dictionary version
    CHAR szTitle[48]; //title of dictionary
    CHAR szDescription[256]; //description of dictionary
    CHAR szCopyright[128]; //copyright info
} IMESHF;

Creating an IFEDictionary Instance

This creates an IFEDictionary object, and returns a pointer to the object. This is one way of obtaining an interface pointer to IFEDictionary. Another way of obtaining this pointer is via IFECommon interface, using the QueryInterface method with IID_IFEDictionary interface ID defined in MSIME.H. This is a DLL function.

HRESULT CreateIFEDictionaryInstance

Operating the Dictionary File Object

HRESULT IFEDictionary::Open

This opens an existing dictionary file and associates it with "this" IFEDictionary object.

To implement a multiple dictionary facility, multiple open/release procedures must be carried out.

HRESULT IFEDictionary::Close

This closes the file associated to this object.

Parameters:    None

HRESULT IFEDictionary::GetHeader

This method obtains the header of a dictionary without opening the dictionary.

HRESULT IFEDictionary::SetHeader

This sets/modifies the dictionary header of "this" IFEDictionary object.

HRESULT IFEDictionary::Create

This creates a user dictionary and associates it with "this" IFEDictionary object.

ULONG IFEDictionary::Release

This frees the IFEDictionary object.

Getting and Registering Words

HRESULT IFEDictionary::GetPosTable

This method obtains the public POS (Part of Speech) table. Since this table is language and IME dependent, clients must include an appropriate header for a particular language. For Japanese, the header is named "msime.h" and includes the following data structure.

POSTBL

//POS table data structure
typedef struct _POSTBL {
    WORD nPos; //pos number
    BYTE *szName; //name of pos
} POSTBL;

HRESULT IFEDictionary::GetWords

This method gets word entries from a dictionary. The selection can be performed by a combination of: 1) a string with Japanese phonetic characters, with or without a wildcard at the end of the string, 2) a word, with or without a wildcard at its end, 3) by Part of Speech. In addition, retrievals by a string with Japanese phonetic characters can be performed by specifying a range in the Hiragana 50-on ordering.

HRESULT IFEDictionary::NextWords

The following must be used after GetWords to get additional words:

HRESULT IFEDictionary::ExistWord

This determines whether the specified word exists in the IFEDictionary.

HRESULT IFEDictionary::RegisterWord

This registers a word in the IFEDictionary.

HRESULT IFEDictionary::DisplayProperty

Invokes the OpenProperty method of the IImeActiveDict interface. This only works when the current dictionary has the IImeActiveDict interface.