Journal.mark

From OpenEUO
Revision as of 20:32, 8 January 2011 by Ximan (Talk | contribs) (Created page with "== Calling Pattern == Call local j = sl.journal() later local a,b = j.mark(at[,fromcurrent]) Arguments at is a number fromcurrent (optional) is a boolean, default is false Re...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Calling Pattern

Call

local j = sl.journal()

later

local a,b = j.mark(at[,fromcurrent])

Arguments

at is a number
fromcurrent (optional) is a boolean, default is false

Returns

a is a number, the number of messages skipped over
b is a number, the number of unread lines since last mark or nextline call

Description

Mark sets index to the last read line used by the nextline method. Mark either sets the absolute position of the last read line, or if the optional second parameter is true, the position is set relative to the current index. Mark returns the number of messages skipped over and the remaining number of unread messages.

See Also