EditorBookMarks

Far Manager

previous page next page

EditorBookMarks

main | structures
The EditorBookMarks structure is used in the EditorControl function to retrieve information about bookmarks in the current editor (ECTL_GETBOOKMARKS command). 
struct EditorBookMarks
{
  long *Line;
  long *Cursor;
  long *ScreenLine;
  long *LeftPos;
  DWORD Reserved[4];
};

Elements

Line
Pointer to an array of line numbers for each bookmark.
Cursor
Pointer to an array of cursor positions for each bookmark.
ScreenLine
Points to an array of line numbers specifying the first line visible on the screen for each bookmark.
LeftPos
Points to an array of positions specifying the leftmost character visible on the screen for each bookmark.
Reserved
Reserved for future use.

Remarks

  1. Before retrieving information about bookmarks you should determine the length of the arrays Line, Cursor, ScreenLine and LeftPos and allocate the required amount of memory for them. The bookmark count is stored in the BookMarkCount member of the EditorInfo structure.
  2. If a plugin does not need the information stored in one of the arrays, it should set the respective member of the structure to NULL.
See also:
Structures | TEditorBookMarks
previous page start next page