IActiveIMMIME::GetDescriptionW method

Copies the description of the Active Input Method Editor (IME) to the specified buffer. (Unicode implementation).

Syntax

HRESULT GetDescriptionW(
  [in]  HKL    hKL,
  [in]  UINT   uBufLen,
  [out] LPWSTR szDescription,
  [out] UINT   *puCopied
);

Parameters

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

  • uBufLen [in]
    An unsigned long integer value that contains the size of the buffer in characters.

  • szDescription [out]
    The address of a string buffer that receives the null-terminated string that describes the Active IME.

  • puCopied [out]
    The address of an unsigned long integer that receives the number of characters that are copied to the buffer. If uBufLen is zero, puCopied receives the buffer size, in characters, that is required to receive the description.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

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

GetDescriptionA