imm.h header

This header is used by Internationalization for Windows Applications. For more information, see:

imm.h contains the following programming interfaces:

Functions

Title Description
ImmAssociateContext Associates the specified input context with the specified window. By default, the operating system associates the default input context with each window as it is created.
ImmAssociateContextEx Changes the association between the input method context and the specified window or its children.
ImmConfigureIMEA Displays the configuration dialog box for the IME of the specified input locale identifier.
ImmConfigureIMEW Displays the configuration dialog box for the IME of the specified input locale identifier.
ImmCreateContext Creates a new input context, allocating memory for the context and initializing it. An application calls this function to prepare its own input context.
ImmDestroyContext Releases the input context and frees associated memory.
ImmDisableIME Disables the IME for a thread or for all threads in a process.
ImmDisableLegacyIME Indicates that this thread is a Windows Store app UI thread.
ImmDisableTextFrameService ImmDisableTextFrameService is no longer available for use as of Windows Vista.
ImmEnumInputContext Retrieves the input context for the specified thread.
ImmEnumRegisterWordA Enumerates the register strings having the specified reading string, style, and register string.
ImmEnumRegisterWordW Enumerates the register strings having the specified reading string, style, and register string.
ImmEscapeA Accesses capabilities of particular IMEs that are not available through other IME API functions. This function is used mainly for country-specific operations.
ImmEscapeW Accesses capabilities of particular IMEs that are not available through other IME API functions. This function is used mainly for country-specific operations.
ImmGetCandidateListA Retrieves a candidate list.
ImmGetCandidateListCountA Retrieves the size of the candidate lists.
ImmGetCandidateListCountW Retrieves the size of the candidate lists.
ImmGetCandidateListW Retrieves a candidate list.
ImmGetCandidateWindow Retrieves information about the candidates window.
ImmGetCompositionFontA Retrieves information about the logical font currently used to display characters in the composition window.
ImmGetCompositionFontW Retrieves information about the logical font currently used to display characters in the composition window.
ImmGetCompositionStringA Retrieves information about the composition string.
ImmGetCompositionStringW Retrieves information about the composition string.
ImmGetCompositionWindow Retrieves information about the composition window.
ImmGetContext Returns the input context associated with the specified window.
ImmGetConversionListA Retrieves the conversion result list of characters or words without generating any IME-related messages.
ImmGetConversionListW Retrieves the conversion result list of characters or words without generating any IME-related messages.
ImmGetConversionStatus Retrieves the current conversion status.
ImmGetDefaultIMEWnd Retrieves the default window handle to the IME class.
ImmGetDescriptionA Copies the description of the IME to the specified buffer.
ImmGetDescriptionW Copies the description of the IME to the specified buffer.
ImmGetGuideLineA Retrieves information about errors. Applications use the information for user notifications.
ImmGetGuideLineW Retrieves information about errors. Applications use the information for user notifications.
ImmGetIMEFileNameA Retrieves the file name of the IME associated with the specified input locale.
ImmGetIMEFileNameW Retrieves the file name of the IME associated with the specified input locale.
ImmGetImeMenuItemsA Retrieves the menu items that are registered in the IME menu of a specified input context.
ImmGetImeMenuItemsW Retrieves the menu items that are registered in the IME menu of a specified input context.
ImmGetOpenStatus Determines whether the IME is open or closed.
ImmGetProperty Retrieves the property and capabilities of the IME associated with the specified input locale.
ImmGetRegisterWordStyleA Retrieves a list of the styles supported by the IME associated with the specified input locale.
ImmGetRegisterWordStyleW Retrieves a list of the styles supported by the IME associated with the specified input locale.
ImmGetStatusWindowPos Retrieves the position of the status window.
ImmGetVirtualKey Retrieves the original virtual key value associated with a key input message that the IME has already processed.
ImmInstallIMEA Installs an IME.
ImmInstallIMEW Installs an IME.
ImmIsIME Determines if the specified input locale has an IME.
ImmIsUIMessageA Checks for messages intended for the IME window and sends those messages to the window.
ImmIsUIMessageW Checks for messages intended for the IME window and sends those messages to the window.
ImmNotifyIME Notifies the IME about changes to the status of the input context.
ImmRegisterWordA Registers a string with the dictionary of the IME associated with the specified input locale.
ImmRegisterWordW Registers a string with the dictionary of the IME associated with the specified input locale.
ImmReleaseContext Releases the input context and unlocks the memory associated in the input context. An application must call this function for each call to the ImmGetContext function.
ImmSetCandidateWindow Sets information about the candidates window.
ImmSetCompositionFontA Sets the logical font to use to display characters in the composition window.
ImmSetCompositionFontW Sets the logical font to use to display characters in the composition window.
ImmSetCompositionStringA Sets the characters, attributes, and clauses of the composition and reading strings.
ImmSetCompositionStringW Sets the characters, attributes, and clauses of the composition and reading strings.
ImmSetCompositionWindow Sets the position of the composition window.
ImmSetConversionStatus Sets the current conversion status.
ImmSetOpenStatus Opens or closes the IME.
ImmSetStatusWindowPos Sets the position of the status window.
ImmSimulateHotKey Simulates the specified IME hot key, causing the same response as if the user presses the hot key in the specified window.
ImmUnregisterWordA Removes a register string from the dictionary of the IME associated with the specified input locale.
ImmUnregisterWordW Removes a register string from the dictionary of the IME associated with the specified input locale.

Callback functions

Title Description
IMCENUMPROC An application-defined callback function that processes input contexts provided by the ImmEnumInputContext function.
REGISTERWORDENUMPROCA An application-defined callback function used with the ImmEnumRegisterWord function.
REGISTERWORDENUMPROCW An application-defined callback function used with the ImmEnumRegisterWord function.

Structures

Title Description
CANDIDATEFORM Contains position information for the candidate window.
CANDIDATELIST Contains information about a candidate list.
COMPOSITIONFORM Contains style and position information for a composition window.
IMECHARPOSITION Contains information about the character position in the composition window.
IMEMENUITEMINFOA Contains information about IME menu items.
IMEMENUITEMINFOW Contains information about IME menu items.
RECONVERTSTRING Defines the strings for IME reconversion. It is the first item in a memory block that contains the strings for reconversion.
REGISTERWORDA Contains reading information or a word to register.
REGISTERWORDW Contains reading information or a word to register.
STYLEBUFA Contains the identifier and name of a style.
STYLEBUFW Contains the identifier and name of a style.