IActiveIMMIME::GetIMEFileNameA method

Gets the file name of the Active Input Method Editor (IME) that is associated with the specified keyboard layout. (ANSI implementation).

Syntax

HRESULT GetIMEFileNameA(
  [in]  HKL   hKL,
  [in]  UINT  uBufLen,
  [out] LPSTR szFileName,
  [out] UINT  *puCopied
);

Parameters

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

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

  • szFileName [out]
    The address of a string value that receives the file name.

  • puCopied [out]
    The address of an unsigned integer value that receives the number of bytes copied to the buffer. If uBufLen is zero, puCopied receives the buffer size, in bytes, that is required to receive the file name.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

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

GetIMEFileNameW