IFEDictionary::Open method (msime.h)

Opens a dictionary file.

This method opens an existing dictionary file and associates it with this IFEDictionary object. To implement a multiple dictionary facility, multiple open and release procedures must be carried out.

Syntax

HRESULT Open(
  [in, optional] CHAR   *pchDictPath,
  [out]          IMESHF *pshf
);

Parameters

[in, optional] pchDictPath

Points to a NULL-terminated file name string to be opened. If pchDictPath is NULL or an empty string, the user dictionary opened by the IME kernel will be used. If pchDictPath is an empty string, the name of user dictionary will be copied into pchDictPath, in which case the size of pchDictPath must be MAX_PATH.

[out] pshf

The IMESHF header of the opened file. Can be NULL.

Return value

One of the following:

  • S_OK
  • JDIC_S_EMPTY_DICTIONARY
  • IFED_E_NOT_FOUND
  • IFED_E_INVALID_FORMAT
  • IFED_E_OPEN_FAILED
  • E_FAIL

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

IMESHF