Edit

Share via

Edit_GetLine macro (windowsx.h)

  • Article

Retrieves a line of text from an edit or rich edit control. You can use this macro or send the EM_GETLINE message explicitly.

Syntax

int Edit_GetLine(
   HWND   hwndCtl,
   int    line,
   LPTSTR lpch,
   int    cchMax
);

Parameters

hwndCtl

Type: HWND

A handle to the control.

line

Type: int

The zero-based index of the line. This parameter is ignored by a single-line edit control.

lpch

Type: LPTSTR

A pointer to a buffer that receives the string.

cchMax

Type: int

The maximum number of characters to be copied to the buffer.

Return value

Type: int

The return value is the number of TCHARs copied. The return value is zero if the line number specified by the line parameter is greater than the number of lines in the edit control.

Remarks

For more information, see EM_GETLINE

Requirements

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