Doc: windowport putmsghistory
This commit is contained in:
+7
-5
@@ -681,7 +681,7 @@ getmsghistory(init)
|
|||||||
with the most recent.
|
with the most recent.
|
||||||
If init is TRUE, start over again from most recent message.
|
If init is TRUE, start over again from most recent message.
|
||||||
|
|
||||||
putmsghistory(msg)
|
putmsghistory(const char *msg, boolean restoring)
|
||||||
-- This is the counterpart to getmsghistory() for restores
|
-- This is the counterpart to getmsghistory() for restores
|
||||||
used to reload the port's message recall buffer.
|
used to reload the port's message recall buffer.
|
||||||
The routine is called repeatedly from the core restore
|
The routine is called repeatedly from the core restore
|
||||||
@@ -690,14 +690,16 @@ putmsghistory(msg)
|
|||||||
savefile. The window port routine is expected to load the
|
savefile. The window port routine is expected to load the
|
||||||
message recall buffers in such a way that the ordering
|
message recall buffers in such a way that the ordering
|
||||||
remains correct. The window port routine should make no
|
remains correct. The window port routine should make no
|
||||||
assumptions about how
|
assumptions about how many messages are forthcoming, nor
|
||||||
many messages are forthcoming, nor should it assume that
|
should it assume that another message will follow this one,
|
||||||
another message will follow this one, so it must be careful
|
so it must be careful to keep all pointers/indexes intact
|
||||||
to keep all pointers/indexes intact at the end of each call.
|
at the end of each call.
|
||||||
If the window port receives more messages that can fit in
|
If the window port receives more messages that can fit in
|
||||||
its buffers, it is expected to scroll away the oldest from
|
its buffers, it is expected to scroll away the oldest from
|
||||||
its buffers, much like it would with new messages being
|
its buffers, much like it would with new messages being
|
||||||
produced.
|
produced.
|
||||||
|
At the end of restoring messages, this will be called
|
||||||
|
one more time with msg NULL.
|
||||||
|
|
||||||
|
|
||||||
III. Global variables
|
III. Global variables
|
||||||
|
|||||||
Reference in New Issue
Block a user