hiReplayFile

hiReplayFile(
s_fileName 
) 
=> t / nil 

Description

Replays a log file. Use this function only for testing or debugging. In general, use the functions load or loading instead of hiReplayFile. hiReplayFile is intended to be run only from a Command Interpreter Window.

Only the input lines (prefixed by \i), the accelerated input lines (prefixed by \a), and lines that have no backslash prefix are filtered from the replay file and sent to SKILL.

If hiReplayFile is used in a SKILL file, all the commands in the SKILL file, including the ones that follow hiReplayFile, runs before the commands in the replay file. If the SKILL file is embedded in another SKILL file, all the commands in that file run before the commands in the replay file.

Because hiReplayFile replays a log file, to read a SKILL file (and execute functions in it), use the functions load or loadi instead.

hiReplayFile does not start from a replay file (a file being replayed by the -replay command line argument or by using hiReplayFile).

Arguments

s_fileName

The file to be read. Do not specify a file that has the hiReplayFile function in it.

Values Returned

t	The file is read.
nil	The file is not read. An error message is displayed.

Related Topics

Log File Functions

hiIsInReplay

hiGetLogFileName

Return to top