Share via

IActiveIMMIME::SetCompositionStringA method

Sets the characters, attributes, and clauses of the composition string and the reading string. (ANSI implementation).

Syntax

HRESULT SetCompositionStringA(
  [in] HIMC   hIMC,
  [in] DWORD  dwIndex,
  [in] LPVOID pComp,
  [in] DWORD  dwCompLen,
  [in] LPVOID pRead,
  [in] DWORD  dwReadLen
);

Parameters

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

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

  • pComp [in]
    The address of the buffer that contains the information to set for the composition string. The information is as specified by the dwIndex value.

  • dwCompLen [in]
    An unsigned long integer value that contains the size, in bytes, of the information buffer for the composition string.

  • pRead [in]
    The address of the buffer that contains the information to set for the reading string. The information is as specified by the dwIndex value.

  • dwReadLen [in]
    An unsigned long integer value that contains the size, in bytes, of the information buffer for the reading string.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

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

SetCompositionStringW