Help Center

CEdit.GetLinemethod

Copies a line of text from an edit control.

WindowsmethodCEdit.incdocumented

Syntax

FUNCTION GetLine (BYVAL hEdit AS HWND, BYVAL which AS DWORD) AS DWSTRING

Parameters

NameDescription
hEditThe handle of the edit control.
whichThe zero-based index of the line to retrieve from a multiline edit control. A value of zero specifies the topmost line. This parameter is ignored by a single-line edit control.

Return value

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

Description

Copies a line of text from an edit control and places it in a specified buffer. You can send this message to either an edit control or a rich edit control.

Remarks

The copied line does not contain a terminating null character.

Example

DIM dwsText AS DWSTRING = CEdit.GetLine(hEdit, 5)

Reference

  • Include file CEdit.inc
  • Defined in AfxNova/CEdit.inc:295
  • Documented in Windows/WIndows Controls/CEdit Class.md
  • Topic: CEdit Class