hiSetEncapHistory
hiSetEncapHistory(
w_window
t_msg
[ g_redraw ]
)
=> t / nil
Description
Copies a message into the next available insertion position in an encapsulation output window.
Arguments
|
w_window
|
Encapsulation window ID returned from hiEncap.
|
|
t_msg
|
String that you want appended (inserted) to the last line of the output portion of the encapsulation window.
|
|
g_redraw
|
Determines whether a message sent to the encapsulation output window is displayed or saved. If set to nil, messages sent to the encapsulation window are buffered (saved) and are not displayed until a newline character is explicitly specified in t_msg. For performance reasons, this flag should be set when sending long strings to the window. If set to t (the default), all messages sent to the encapsulation window are immediately displayed with a newline automatically appended.
If the property noAutoNewline on the encapsulation window is set to t, the newline is not automatically appended to the t_msg string, and a ’\n’ character must be explicitly specified in the string before the string is sent and displayed to the window output.
|
Values Returned
|
t
|
The string is copied to the encapsulation output window.
|
|
nil
|
The string is not copied to the encapsulation output window. A warning is also issued.
|
Related Topics
Encapsulation Window
hiEncap
Return to top
