Help Center

CRichEditCtx.GetIMECompTextmethod

Gets the Input Method Editor (IME) composition text.

Windowsmethoddocumented

Syntax

FUNCTION GetIMECompText (BYREF ict AS .IMECOMPTEXT, BYVAL buffer AS ANY PTR) AS DWORD

Parameters

NameDescription
ictA IMECOMPTEXT structure.
bufferThe buffer that receives the composition text. The size of this buffer is contained in the cb member of the IMECOMPTEXT structure.

Return value

If successful, the return value is the number of Unicode characters copied to the buffer. Otherwise, it is zero.

Description

Gets the Input Method Editor (IME) composition text.

Remarks

This message only takes Unicode strings.

Security Warning: Be sure to have a buffer sufficient for the size of the input. Failure to do so could cause problems for your application.

Reference

  • Defined in AfxNova/CRichEditCtx.inc:2704
  • Documented in Windows/WIndows Controls/RichEdit/CRichEditCtx Class.md
  • Topic: CRichEditCtx Class