ImmGetCompositionString

The ImmGetCompositionString function retrieves information about the composition string.

LONG ImmGetCompositionString(
  HIMC hIMC,      
  DWORD dwIndex,  
  LPVOID lpBuf,   
  DWORD dwBufLen  
);

Parameters

hIMC

[in] Handle to the input context.

dwIndex

[in] Index of the information to retrieve. This parameter can be one of the values specified in IME Composition String Values. For each value except GCS_CURSORPOS and GCS_DELTASTART, the function copies the requested information to the specified buffer. The function returns the cursor and delta position values in the low 16-bits of the return value.

lpBuf

[out] Pointer to a buffer that receives the requested information.

dwBufLen

[in] Specifies the size of the buffer, in bytes. This is true even if the buffer contains a Unicode string. If zero, this function returns the buffer size needed for the complete information.

Return Values

Returns the number of bytes copied to the destination buffer or, if dwBufLen is zero, the buffer size, in bytes, needed to receive all of the requested information, not including the null terminating character. The return value is always the size in bytes, even if the requested data is a Unicode string. On an error, the function returns one of the following negative error values.

Remarks

An application calls this function in response to the WM_IME_COMPOSITION or WM_IME_STARTCOMPOSITION message. The IMM removes the information when an application calls the ImmReleaseContext function.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.
  Library: Use Imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Input Method Editor Overview, Input Method Editor Functions, ImmReleaseContext, WM_IME_COMPOSITION, WM_IME_STARTCOMPOSITION