IActiveIMMIME::GetCompositionStringA method

Gets information about the composition string. (ANSI implementation).

Syntax

HRESULT GetCompositionStringA(
  [in]  HIMC   hIMC,
  [in]  DWORD  dwIndex,
  [in]  DWORD  dwBufLen,
  [out] long       *plCopied,
  [out] LPVOID pBuf
);

Parameters

  • hIMC [in]
    A handle to the input context.

  • dwIndex [in]
    An unsigned long integer value that contains the index of the information to get.

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

  • plCopied [out]
    The address of a long integer value that receives the number of bytes that are copied to the buffer. If dwBufLen is zero, plCopied receives the number of bytes that are required to receive all of the requested information.

  • pBuf [out]
    The address of the buffer to receive the information.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

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

GetCompositionStringW