ImmGetImeMenuItems

[This is preliminary documentation and subject to change.]

The ImmGetImeMenuItems function retrieves the menu items that are registered in the IME menu.

DWORD WINAPI ImmGetImeMenuItems(
   HIMC                hIMC,
   DWORD               dwFlags,
   DWORD               dwType,
   LPIMEMENUITEMINFO   lpImeParentMenu,
   LPIMEMENUITEMINFO   lpImeMenu,
   DWORD               dwSize
);
 

Parameters

hIMC

Handle to the input context.

dwFlags

Menu information flags. The following value is defined:

Value	Meaning
IGIMIF_RIGHTMENU	If set, the function returns the menu items for the context menu (obtained by a right mouse click).

dwType

Type of menu returned by this function. This parameter can be a combination of the following values.

Value	Meaning
IGIMII_CMODE	Returns the menu items that control the conversion mode.
IGIMII_SMODE	Returns the menu items that control sentence mode.
IGIMII_CONFIGURE	Returns the menu items that are related to configuration.
IGIMII_TOOLS	Returns the menu items that are related to tools.
IGIMII_HELP	Returns the menu items that control help.
IGIMII_OTHER	Returns the menu items that control other IME functions.
IGIMII_INPUTTOOLS	Returns the menu items that control input tools.

lpImeParentMenu

Pointer to the parent menu. It points to a IMEMENUITEMINFO structure with the fType member set to MFT_SUBMENU in order to return information about the submenu items of this parent menu. If this parameter is NULL, however, the function returns only top-level menu items.

lpImeMenu

Pointer to a buffer to receive the contents of the menu items. The buffer is an array of IMEMENUINFO structures. If this parameter is NULL, the function returns the number of registered menu items.

dwSize

The size of the buffer to receive the IMEMENUITEMINFO structure.

Return Values

The return value is the number of menu items that were copied into lpImeMenu. If lpImeMenu is NULL, the function returns the number of registered menu items.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in imm.h.
  Import Library: Use imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Input Method Editor Overview, Input Method Editor Functions, IMEMENUITEMINFO