[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.OpenLog


Name OpenLog
Type Method
Summary Opens a log file.
Prototype long OpenLog(BSTR LogFileName, BOOL Append);

View list of 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.
Returns eOK: opened OK
eCouldNotOpenLogFile: unable to open the log file
eLogFileAlreadyOpen: log file was already open

View list of return code meanings


See also ...

Function Description
CloseLog Closes the log file
FlushLog Flushes the log file to disk
IsLogOpen Tests to see if a log file is open
WriteLog Writes to the log file

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]