IActiveIMMIME::GetRegisterWordStyleA method

Gets a list of the styles that are supported by the Active Input Method Editor (IME) that is associated with the specified keyboard layout. (ANSI implementation).

Syntax

HRESULT GetRegisterWordStyleA(
  [in]  HKL       hKL,
  [in]  UINT      nItem,
  [out] STYLEBUFA *pStyleBuf,
  [out] UINT      *puCopied
);

Parameters

  • hKL [in]
    A handle to the keyboard layout.

  • nItem [in]
    An unsigned integer value that contains the maximum number of styles that the buffer can hold.

  • pStyleBuf [out]
    The address of a STYLEBUFA structure that receives the style information.

  • puCopied [out]
    The address of an unsigned integer value that receives the number of layout handles that are copied to the buffer, or if nItem is zero, receives the buffer size in array elements that is required to receive all available style information.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method maps to the ImmGetRegisterWordStyle function that is documented in the Windows Software Development Kit (SDK).

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Dimm.h

IDL

Dimm.idl

See also

IActiveIMMIME

GetRegisterWordStyleW