ImmGetImeMenuItemsA function (imm.h)

Article
02/09/2023

Retrieves the menu items that are registered in the IME menu of a specified input context.

Syntax

DWORD ImmGetImeMenuItemsA(
  [in]            HIMC               unnamedParam1,
  [in]            DWORD              unnamedParam2,
  [in]            DWORD              unnamedParam3,
  [out, optional] LPIMEMENUITEMINFOA lpImeParentMenu,
  [out, optional] LPIMEMENUITEMINFOA lpImeMenu,
  [in]            DWORD              dwSize
);

Parameters

[in] unnamedParam1

Handle to the input context for the specified menu items.

[in] unnamedParam2

Flag specifying menu information options. The following value is defined.

Value	Meaning
IGIMIF_RIGHTMENU	Retrieve the menu items for the context menu, obtained by a right mouse click.

[in] unnamedParam3

Type of menu to retrieve. This parameter can have one or more of the following values.

Value	Meaning
IGIMII_CMODE	Retrieve the menu items that control conversion mode.
IGIMII_SMODE	Retrieve the menu items that control sentence mode.
IGIMII_CONFIGURE	Retrieve the menu items that are related to IME configuration.
IGIMII_TOOLS	Retrieve the menu items that are related to IME tools.
IGIMII_HELP	Retrieve the menu items that control IME Help.
IGIMII_OTHER	Retrieve the menu items that control other IME functions.
IGIMII_INPUTTOOLS	Retrieve the menu items that control menu items related to IME input tools providing an extended way to input characters.

[out, optional] lpImeParentMenu

Pointer to an IMEMENUITEMINFO structure in which the function retrieves parent menu information. To retrieve information about the submenu items of this parent menu, the application sets the fType member to MFT_SUBMENU. This parameter contains NULL if the function retrieves only top-level menu items.

[out, optional] lpImeMenu

Pointer to an array of IMEMENUITEMINFO structures in which the function retrieves information about the menu items. This parameter contains NULL if the function retrieves the number of registered menu items.

[in] dwSize

Size of the buffer to receive the IMEMENUITEMINFO structure.

Return value

Returns the number of menu items copied into lpImeMenu. If lpImeMenu specifies NULL, the function returns the number of registered menu items in the specified input context.

Remarks

Note

The imm.h header defines ImmGetImeMenuItems as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only],East Asian language support installed.
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imm.h (include Immdev.h, Windows.h)
Library	Imm32.lib
DLL	Imm32.dll