world.OpenLog

MUSHclient script function (Method)

Opens a log file.

Prototype

long OpenLog(BSTR LogFileName, BOOL Append);

Data type meanings

Description

This opens a log file of the name "LogFileName", with optional appending to an existing file of the same name. No previous output lines are written (as may happen when you use the ‘open log’ dialog box), nor is a log-file preamble written. If you want to write those things to the script file, you must do them yourself (see WriteLog).

If an empty filename is supplied (that is, "") then the filename specified in the Logging configuration will be used, which lets you use substitutions in the name of the file (eg. the date).

VBscript example

world.openlog "mylog.txt", false

Jscript example

world.openlog("mylog.txt", false);

PerlScript example

$world->openlog("mylog.txt", false);

Python example

world.openlog("mylog.txt", False)

Lua example

OpenLog ("mylog.txt", false)

Lua notes

The Append flag is optional, and defaults to false.

Return value

eOK: opened OK
eCouldNotOpenLogFile: unable to open the log file
eLogFileAlreadyOpen: log file was already open

Return code meanings

Related topic

Logging

See also