EditorGetString

previous page next page

The EditorGetString structure is used in the EditorControl function to retrieve a text line from the FAR editor.

struct EditorGetString
{
  int StringNumber;
  const char *StringText;
  const char *StringEOL;
  int StringLength;
  int SelStart;
  int SelEnd;
};

StringNumber

Zero-based index of the line to retrieve. Can be set to -1 to retrieve the current line (see this article regarding the -1 value).

StringText

Pointer to line data. Cannot be modified. Note, that line data is not a zero-terminated string and can contain ASCII NULL-s.

StringEOL

End-of-line sequence. Can be the empty string, \r\n or \n

StringLength

Size of data pointed to by StringText.

SelStart

Start position of selection in the line. If line doesn't contain selection this field has a value of -1.

SelEnd

End position of selection in the line. If selection includes the StringEOL sequence this field has a value of -1.