Help Center
/
Help Center›AfxNova›RichEdit Procedures

RichEdit_GetIMECompTextfunction

Retrieves the Input Method Editor (IME) composition text.

Windowsfunctiondocumented

Syntax

FUNCTION RichEdit_GetIMECompText (BYVAL hRichEdit AS HWND, BYVAL lpict AS IMECOMPTEXT PTR, BYVAL buffer AS ANY PTR) AS DWORD

Parameters

NameDescription
hRichEditThe handle of the rich edit control.
lpictA pointer to the 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

Retrieves 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/AfxRichEdit.inc:294
  • Documented in Windows/WIndows Controls/RichEdit/RichEdit Procedures.md
  • Topic: RichEdit Procedures