IActiveIMMIME::EnumRegisterWordA Method

Creates an enumeration object that will enumerate the register strings having the specified reading string, style, and register string. ANSI implementation.

Syntax

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

Parameters

hKL

[in] Handle to the keyboard layout.

szReading

[in] Address of a string value that contains the reading string to be enumerated. If NULL, this method enumerates all available reading strings that match with the values specified by dwStyle and szRegister.

dwStyle

[in] Unsigned long integer value that contains the style to be enumerated. If set to zero, this method enumerates all available styles that match with the values specified by szReading and szRegister.

szRegister

[in] Address of a string value that contains the register string to enumerate. If NULL, this method enumerates all register strings that match with the values specified by szReading and dwStyle.

pData

[in] Address of a buffer containing data supplied by the application.

pEnum

[out] Address of a pointer to the IEnumRegisterWordA interface of the enumeration object.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

This method maps to the ImmEnumRegisterWord function documented in the Microsoft® Platform Software Development Kit (SDK).