IActiveIMMApp::GetImeMenuItemsA method

  • Article

Gets the menu items that are registered in the Input Method Editor (IME) menu (ANSI implementation).

Syntax

HRESULT GetImeMenuItemsA(
  [in]  HIMC             hIMC,
  [in]  DWORD            dwFlags,
  [in]  DWORD            dwType,
  [in]  IMEMENUITEMINFOA *pImeParentMenu,
  [out] IMEMENUITEMINFOA *pImeMenu,
  [in]  DWORD            dwSize,
  [out] DWORD            *pdwResult
);

Parameters

  • hIMC [in]
    A handle to the input context.

  • dwFlags [in]
    An unsigned long integer value that contains the menu information flags.

  • dwType [in]
    An unsigned long integer value that contains the type of menu that is returned by this method.

  • pImeParentMenu [in]
    The address of an IMEMENUITEMINFOA structure that has the fType member set to IMFT_SUBMENU to return information about the submenu items of this parent menu. If this parameter is NULL, the function returns only top-level menu items.

  • pImeMenu [out]
    The address of an array of IMEMENUITEMINFOA structures to receive the contents of the menu items.

  • dwSize [in]
    An unsigned long integer value that contains the size of the buffer to receive the structures.

  • pdwResult [out]
    The address of an unsigned long integer value that receives the number of menu items that are copied into pImeMenu. If pImeMenu is null, the function returns the number of registered menu items.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method is only available for Windows 98 and Microsoft Windows NT 4.0. This method maps to the ImmGetImeMenuItems function that is documented in the Windows Software Development Kit (SDK).

Requirements

Minimum supported client

 Windows XP

Minimum supported server

 Windows 2000 Server

Product

 Internet Explorer 5.0

Header

 Dimm.h

IDL

 Dimm.idl

See also

IActiveIMMApp