ImeEscape

LRESULT ImeEscape(HIMC hIMC, UINT uEscape, LPVOID lpData)
 

Allows an application to access the capabilities of a particular IME that are not directly available though other IMM functions. This is necessary mainly for country-specific functions or private functions in IME.

The return value depends on the escape function specified by uEscape. It is zero if the function fails.

hIMC
Handle of the input context.
uEscape
Escape function to perform. Each escape function should include parameter validation. Can be one of these values:
IME_ESC_QUERY _SUPPORT Checks for implementation. If this escape is not implemented, the return value is zero.
IME_ESC_RESERVED_FIRST The escape between IME_ESC_RESERVED_FIRST and IME_ESC_RESERVED_LAST is reserved by the system.
IME_ESC_RESERVED_LAST The escape between IME_ESC_RESERVED_FIRST and IME_ESC_RESERVED_LAST is reserved by the system.
IME_ESC_PRIVATE_FIRST The escape between IME_ESC_PRIVATE_FIRST and IME_ESC_PRIVATE_LAST is reserved for the IME. The IME can freely use these escape functions for its own purposes.
IME_ESC_PRIVATE_LAST The escape between IME_ESC_PRIVATE_FIRST and IME_ESC_PRIVATE_LAST is reserved for the IME. The IME can freely use these escape functions for its own purposes.
IME_ESC_SEQUENCE_TO_INTERNAL The escape is Chinese specific. An application that needs to run under all Asian platforms should not use it. It is for the Chinese EUDC editor. The lpData parameter is the sequence code, and the return value is the character code for this sequence code. Typically, the Chinese IME encodes its reading character codes into sequence 1 to n.
IME_ESC_GET_EUDC_DICTIONARY The escape is Chinese specific. An application that needs to run under all Asian platforms should not use it. It is for the Chinese EUDC editor. On return from the function, the lpData is filled with the full path file name of the EUDC dictionary. The size of the buffer pointed to by lpData should be greater or equal to 80 * sizeof(TCHAR).
IME_ESC_SET_EUDC_DICTIONARY The escape is Chinese specific. An application that needs to run under all Asian platforms should not use it. It is for the Chinese EUDC editor. On return from the function, the lpData is the full path file name of the EUDC dictionary. The path name should be less than 80 * sizeof(TCHAR).
IME_ESC_MAX_KEY The escape is Chinese specific. An application that needs to run under all Asian platforms should not use it. It is for the Chinese EUDC editor. The return value is the maximum key stokes for an EUDC character.
IME_ESC_IME_NAME The escape is Chinese specific. An application that needs to run under all Asian platforms should not use it. It is for the Chinese EUDC editor. On return from the function, the lpData is the IME name to be displayed on the EUDC editor. The size of the buffer pointed to by lpData should be greater or equal to 16 * sizeof(TCHAR).
IME_ESC_SYNC_HOTKEY The escape is (Traditional) Chinese specific. An application that needs to run under all Asian platforms should not use it. It is to synchronize between different IMEs. The input parameter lpData is the IME private hot key ID. If this ID is zero, this IME should check every private hot key ID it concerns.
IME_ESC_HANJA_MODE The escape is Korean specific. An application that needs to run under all Asian platforms should not use it. It is for conversion from Hangeul to Hanja. The input parameter lpData is filled with Hangeul character which will be converted to Hanja, and its null-terminated string. When the application needs to convert any Hangeul character to Hanja character in the same method of Hanja conversion with the composition character present, the application just requests this function and the IME sets itself as Hanja conversion mode.

lpData
Address of the data required for the escape function specified by uEscape.