CEdit::GetLine

Call this function to retrieve a line of text from an edit control and places it in lpszBuffer.

int GetLine(
   int nIndex,
   LPTSTR lpszBuffer 
) const;
int GetLine(
   int nIndex,
   LPTSTR lpszBuffer,
   int nMaxLength 
) const;

Parameters

  • nIndex
    Specifies the line number to retrieve from a multiple-line edit control. Line numbers are zero-based; a value of 0 specifies the first line. This parameter is ignored by a single-line edit control.

  • lpszBuffer
    Points to the buffer that receives a copy of the line. The first word of the buffer must specify the maximum number of characters that can be copied to the buffer.

  • nMaxLength
    Specifies the maximum number of bytes that can be copied to the buffer. GetLine places this value in the first word of lpszBuffer before making the call to Windows.

Return Value

The number of bytes actually copied. The return value is 0 if the line number specified by nIndex is greater than the number of lines in the edit control.

Remarks

The copied line does not contain a null-termination character.

For more information, see EM_GETLINE in the Windows SDK.

Example

See the example for CEdit::GetLineCount.

Requirements

Header: afxwin.h

See Also

Reference

CEdit Class

Hierarchy Chart

CEdit::LineLength

CWnd::GetWindowText

Other Resources

CEdit Members