IActiveIMMApp::GetDescriptionA Method

---

Copies the description of the IME to the specified buffer. ANSI implementation.

Syntax

HRESULT GetDescriptionA(
    HKL hKL,
    UINT uBufLen,
    LPSTR szDescription,
    UINT *puCopied
);

Parameters

hKL

[in] Handle to the keyboard layout.

uBufLen

[in] Unsigned long integer value that contains the size of the buffer in characters.

szDescription

[out] Address of a string buffer that receives the null-terminated string describing the IME.

puCopied

[out] Address of an unsigned long integer that receives the number of characters copied to the buffer. If uBufLen is zero, puCopied receives the buffer size, in characters, needed to receive the description.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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