IActiveIMMIME::GetRegisterWordStyleA Method

Retrieves a list of the styles supported by the IME associated with the specified keyboard layout. ANSI implementation.

Syntax

HRESULT GetRegisterWordStyleA(
    HKL hKL,
    UINT nItem,
    STYLEBUFA *pStyleBuf,
    UINT *puCopied
);

Parameters

hKL

[in] Handle to the keyboard layout.

nItem

[in] Unsigned integer value that contains the maximum number of styles that the buffer can hold.

pStyleBuf

[out] Address of a STYLEBUFA structure that receives the style information.

puCopied

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

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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