ImmGetImeMenuItems (Windows Embedded CE 6.0)

1/6/2010

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

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] Value that specifies a menu information flag. The value is defined as follows:

    Value Description

    IGIMIF_RIGHTMENU

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

  • dwType
    [in] Value that specifies the type of menu returned by this function. The following table shows the values this parameter can take. This parameter can be a combination of the values shown in the following table.

    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.

Return Value

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.

Requirements

Header imm.h
Library Coreimm.lib
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

IMEMENUITEMINFO

Other Resources

Input Method Manager (IMM) Functions