IActiveIME::SetCompositionString Method

---

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

Syntax

HRESULT SetCompositionString(
    HIMC hIMC,
    DWORD dwIndex,
    void *pComp,
    DWORD dwCompLen,
    void *pRead,
    DWORD dwReadLen
);

Parameters

hIMC

[in] Handle to the input context.

dwIndex

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

pComp

[in] 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] Unsigned long integer value that specifies the size, in bytes, of the information buffer for the composition string.

pRead

[in] 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] Unsigned long integer value that specifies 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 ImeSetCompositionString function documented in the Microsoft® Windows® 2000 Driver Development Kit.