IFEDictionary::RegisterWord method (msime.h)

  • Article

Registers a new word or deletes an existing word in the IFEDictionary.

Syntax

HRESULT RegisterWord(
  [in] IMEREG reg,
  [in] IMEWRD *pwrd
);

Parameters

[in] reg

Type of operation to perform. This can be one of the following values:

Value Meaning
IFED_REG_HEAD
 Register the word at the head of the dictionary.
IFED_REG_TAIL
 Register the word at the tail of the dictionary.
IFED_REG_DEL
 Delete the word from the dictionary.

[in] pwrd

An IMEWRD structure specifying the word to register or delete.

Return value

This method can return one of these values.

Return code Description
S_OK
 The method was successful.
IFED_E_NOT_USER_DIC
 This IFEDictionary object is not a user dictionary.
IFED_S_WORD_EXISTS
 The word is already registered.
IFED_E_USER_COMMENT
 Failed to insert the user comment.
S_FALSE
 Failed to register or delete the word.
E_FAIL
 An unexpected error.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header msime.h

See also

IFEDictionary

IMEWRD