Edit

Share via

GETTEXTEX structure (richedit.h)

  • Article

Contains information used in getting text from a rich edit control. This structure used with the EM_GETTEXTEX message.

Syntax

typedef struct _gettextex {
  DWORD  cb;
  DWORD  flags;
  UINT   codepage;
  LPCSTR lpDefaultChar;
  LPBOOL lpUsedDefChar;
} GETTEXTEX;

Members

cb

Type: DWORD

The size, in bytes, of the buffer used to store the retrieved text.

flags

Type: DWORD

Value specifying a text operation. This member can be one of the following values.

Value Meaning
GT_DEFAULT
 All text is retrieved according to the following criteria:
  • Carriage returns (U+000D) are not translated into CRLF (U+000D U+000A).
  • Table and math-object structure characters are removed (see GT_RAWTEXT).
  • Hidden text is included.
  • List numbers are not included.
GT_NOHIDDENTEXT
 Hidden text is not included in the retrieved text.
GT_RAWTEXT
 Text is retrieved exactly as it appears in memory. This includes special structure characters for table row and cell delimiters (see Remarks for EM_INSERTTABLE) as well as math object delimiters (start delimiter U+FDD0, argument delimiter U+FDEE, and end delimiter U+FDDF) and object markers (U+FFFC). This maintains character-position alignment between the retrieved text and the text in memory.
GT_SELECTION
 Retrieve the text for the current selection.
GT_USECRLF
 When copying text, translate each CR into a CR/LF.

codepage

Type: UINT

Code page used in the translation. It is CP_ACP for ANSI code page and 1200 for Unicode.

lpDefaultChar

Type: LPCSTR

The character used if a wide character cannot be represented in the specified code page. It is used only if the code page is not 1200 (Unicode). If this member is NULL, a system default value is used.

lpUsedDefChar

Type: LPBOOL

A flag that indicates whether the default character (lpDefaultChar) was used. This member is used only if the code page is not 1200 or CP_UTF8 (Unicode). The flag is TRUE if one or more wide characters in the source string cannot be represented in the specified code page. Otherwise, the flag is FALSE. This member can be NULL.

Remarks

The EM_GETTEXTEX message is faster when both lpDefaultChar and lpUsedDefChar are NULL.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header richedit.h

See also

EM_GETTEXTEX