IFEDictionary::GetWords method (msime.h)

Article
02/22/2024

Gets word entries from a dictionary.

The selection of a word entry can be performed by a combination of

A string with Japanese phonetic characters, with or without a wildcard at the end of the string.
A word, with or without a wildcard at its end.
A 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.

Syntax

HRESULT GetWords(
  [in]      const WCHAR *pwchFirst,
  [in]      const WCHAR *pwchLast,
  [in]      const WCHAR *pwchDisplay,
  [in]      ULONG       ulPos,
  [in]      ULONG       ulSelect,
  [in]      ULONG       ulWordSrc,
  [in, out] UCHAR       *pchBuffer,
  [in]      ULONG       cbBuffer,
  [out]     ULONG       *pcWrd
);

Parameters

[in] pwchFirst

A text string against which IFEDictionary entries are matched; the value must be one of the following:

Value	Meaning
NULL	Low-value.
	Hiragana string (full text to be retrieved).
	Hiragana string ending in "*" (specifying only leading characters of text). This can be an initial text string when a range of words is to be retrieved, in which case a wildcard must not be used.

[in] pwchLast

A text string that is used to end a text string. This must contain the same value as pwchReading in the IMEWRD structure when a retrieval is performed by a single value; that is, not by a range value. The value must be one of the following:

Value	Meaning
NULL	High-value.
	Hiragana string (full text to be retrieved).
	Hiragana string ending in "*" (specifying only leading characters of text).

[in] pwchDisplay

A display string against which IFEDictionary entries are matched; the value must be one of the following:

Value	Meaning
NULL	Means "*".
	Any Japanese string.
	Japanese string ending in "*".

[in] ulPos

Filter(s) on the Microsoft IME public Parts of Speech. This is a combination of one or more of the following flags:

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

[in] ulSelect

Specifies the query output of a word. This is a combination of one or more of the following flags:

IFED_SELECT_NONE

IFED_SELECT_READING

IFED_SELECT_DISPLAY

IFED_SELECT_POS

IFED_SELECT_COMMENT

IFED_SELECT_ALL

[in] ulWordSrc

Specifies the word source. When the IFEDictionary is a user dictionary, this is a combination of one or more of the following flags:

IFED_REG_NONE

IFED_REG_USER

IFED_REG_AUTO

IFED_REG_GRAMMAR

IFED_REG_ALL

[in, out] pchBuffer

Buffer provided by the caller to receive the data.

[in] cbBuffer

The size of pchBuffer.

[out] pcWrd

The number of IMEWRD structures returned in pchBuffer. If more entries are found than pchBuffer can store, IFED_S_MORE_ENTRIES will be returned.

Return value

This method can return one of these values.

Return code	Description
S_OK
IFED_S_MORE_ENTRIES	The client must call NextWords to get additional IMEWRD structures.
IFED_E_NO_ENTRY
E_OUTOFMEMORY
E_FAIL

Requirements

Requirement	Value
Target Platform	Windows
Header	msime.h

Share via