IActiveIMMIME::GetCompositionStringA Method

Retrieves information about the composition string. ANSI implementation.

Syntax

HRESULT GetCompositionStringA(
    HIMC hIMC,
    DWORD dwIndex,
    DWORD dwBufLen,
    LONG *plCopied,
    LPVOID pBuf
);

Parameters

hIMC

[in] Handle to the input context.

dwIndex

[in] Unsigned long integer value that contains the index of the information to retrieve.

dwBufLen

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

plCopied

[out] Address of a long integer value that receives the number of bytes copied to the buffer. If dwBufLen is zero, plCopied receives the number of bytes needed to receive all of the requested information.

pBuf

[out] Address of the buffer to receive the information.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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