IActiveIMMIME::SetCompositionStringA Method

Sets the characters, attributes, and clauses of the composition and reading strings. ANSI implementation.

Syntax

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

Parameters

hIMC

[in] Handle to the input context.

dwIndex

[in] Unsigned long integer value that contains the type of information to set.

pComp

[in] Address of the buffer containing the information to set for the composition string. The information is as specified by the dwIndex value.

dwCompLen

[in] Unsigned long integer value that contains the size, in bytes, of the information buffer for the composition string.

pRead

[in] Address of the buffer containing the information to set for the reading string. The information is as specified by the dwIndex value.

dwReadLen

[in] 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 code otherwise.

Remarks

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