WriteLog
Script function

world.WriteLog

DOC_scripting Read about scripting

Type

Method

Summary

Writes to the log file

Prototype

long WriteLog(BSTR Message);

DOC_data_types View list of data type meanings

Description

This writes a message to the log file.

A "newline" is appended to the line if there is not already one there.

You can also use "LogSend" to send a message to the MUD, and log it, in a single function.

The data in the log file may not appear immediately if you view it in another application. To force the data to disk use the FlushLog function.

VBscript example

world.writelog "--- Message for the log file ---"


Jscript example

world.WriteLog("--- Message for the log file ---");


PerlScript example

$world->WriteLog("--- Message for the log file ---");


Python example

world.WriteLog("--- Message for the log file ---")


Lua example

WriteLog("--- Message for the log file ---")


Lua notes

You can supply multiple arguments, which are concatenated together.


Return value

eOK: written OK
eLogFileBadWrite: unable to write to the log file
eLogFileNotOpen: log file was not open


DOC_errors View list of return code meanings

See Also ...

Topic

DOC_logging Logging

Functions

FNC_CloseLog CloseLog (Closes the log file)
FNC_FlushLog FlushLog (Flushes the log file to disk)
FNC_IsLogOpen IsLogOpen (Tests to see if a log file is open)
FNC_LogInput LogInput (The property of whether commands are logged to the log file)
FNC_LogNotes LogNotes (The property of whether notes are logged to the log file)
FNC_LogOutput LogOutput (The property of whether MUD output is logged to the log file)
FNC_LogSend LogSend (Sends a message to the MUD and logs it)
FNC_OpenLog OpenLog (Opens a log file.)

(Help topic: function=WriteLog)

DOC_contents Documentation contents page