IActiveIMMApp::EnumRegisterWordA method

Article
11/05/2015

Creates an enumeration object that enumerates the register strings with the specified reading string, style, and register string (ANSI implementation).

Syntax

HRESULT EnumRegisterWordA(
  [in]  HKL                hKL,
  [in]  LPSTR              szReading,
  [in]  DWORD              dwStyle,
  [in]  LPSTR              szRegister,
  [in]  LPVOID             pData,
  [out] IEnumRegisterWordA **pEnum
);

Parameters

hKL [in]
A handle to the keyboard layout.
szReading [in]
The address of a string value that contains the reading string to enumerate. If NULL, this method enumerates all available reading strings that match with the specified dwStyle and szRegister.
dwStyle [in]
An unsigned long integer value that contains the style to enumerate. If set to zero, this method enumerates all available styles that match with the specified szReading and szRegister.
szRegister [in]
THe address of a string value that contains the register string to enumerate. If NULL, this method enumerates all register strings that match with the specified szReading and dwStyle.
pData [in]
The address of a buffer containing data supplied by the application.
pEnum [out]
A pointer to the IEnumRegisterWordA interface of the enumeration object.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method maps to the ImmEnumRegisterWord 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

Share via