IFEDictionary::GetWords Method

  • Article

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.

Parameters

Parameter Description

WCHAR * pwchFirst,

(IN) Points to a text string against which IFEDictionary entries are matched; the value must be one of the following:
NULL (meaning "low-value")
Hiragana string (full text to be retrieved)
Hiragana string ended by "*" (specifying only leading characters of text) This can be a initial text string when a range of words is to be retrieved, in which case a wildcard must not be used

WCHAR * pwchLast,

(IN) Points to a text string. This is used to end a text string. This must contain the same value of pwchReading when a retrieval is performed by a single value; that is, not by a range value. The value must be one of the following:
NULL (meaning "high-value")
Hiragana string (full text to be retrieved)
Hiragana string ended by "*" (specifying only leading characters of text)

WCHAR * pwchDisplay,

(IN) Points to a display string against which IFEDictionary entries are matched; the value must be one of the following:
NULL (meaning "*")
Any Japanese string
Japanese string ended by "*"

ULONG ulPos,

The filters of Microsoft IME public POS:
IFED_POS_NONE IFED_POS_NOUN
IFED_POS_VERB
IFED_POS_ADJECTIVE
IFED_POS_ADJECTIVE_VERB
IFED_POS_ADVERB
IFED_POS_ADNOUN
IFED_POS_CONJUNCTION
IFED_POS_INTERJECTION
IFED_POS_INDEPENDENT
IFED_POS_INFLECTIONALSUFFIX
IFED_POS_PREFIX
IFED_POS_SUFFIX
IFED_POS_AFFIX
IFED_POS_TANKANJI
IFED_POS_IDIOMS
IFED_POS_SYMBOLS
IFED_POS_PARTICLE
IFED_POS_AUXILIARY_VERB
IFED_POS_SUB_VERB
IFED_POS_DEPENDENT
IFED_POS_ALL

ULONG ulSelect

(IN) Bit mask that specifies the query output of a word; must be logical OR one of the following:
IFED_SELECT_NONE
IFED_SELECT_READING
IFED_SELECT_DISPLAY
IFED_SELECT_POS
IFED_SELECT_ALL
Other bits are reserved for future extensions (translation, definition, etc.)

ULONG ulWordSrc

(IN) Bit flag to specify the word source; must be logical OR one of the following when the IFEDictionary is a user dictionary:
IFED_REG_NONE
IFED_REG_USER IFED_REG_AUTO
IFED_REG_GRAMMAR
IFED_REG_ALL
Other bits are reserved for future extensions

UCHAR * pchBuffer

(IN/OUT) The caller provides the buffer and this function fills up the data

ULONG cbBuffer

(IN) size of pchBuffer

ULONG * pcWrd

(OUT) Number of IMEWRD structures returned in buffer; if more entries are found than the pchBuffer can store, an IFED_S_MORE_ENTRIES will be returned

Return Values

Return Values

HRESULT

S_OK
IFED_S_MORE_ENTRIES—Client must call IFEDictionary::NextWords Method to get additional IMEWRD structures
IFED_E_NO_ENTRY
E_OUTOFMEMORY
E_FAIL