ImmGetImeMenuItems

This function retrieves the menu items that are registered in the IME menu.

At a Glance

Header file: Imm.h
Windows CE versions: 2.10 and later

Syntax

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

Parameters

hIMC

[in] Handle to the input context.

dwFlags

[in] Specifies a menu information flag. The following value is defined:

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

dwType

[in] Specifies the type of menu returned by this function. This parameter can be a combination of the following values.

Value Description
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

[in] Long 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

[out] Long pointer to a buffer to receive the contents of the menu items. The buffer is an array of IMEMENUITEMINFO structures. If this parameter is NULL, the function returns the number of registered menu items.

dwSize

[in] Specifies the size of the buffer to receive the IMEMENUITEMINFO structure.

Return Values

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