world.AppendToNotepad

MUSHclient script function (Method)

Appends text to a notepad window

Prototype

boolean AppendToNotepad(BSTR Title, BSTR Contents);

Data type meanings

Description

Appends the text to a notepad window of the given title. If no such window exists, it is created.

The function "AppendToNotepad" does not activate (bring to the front) the notepad window. However the function "ActivateNotepad" can be used to do that.

You can use world.activate to activate the world itself (eg. you might want to do that after creating a notepad window).

You might use GetNotepadLength to check if there is likely to be room in the notepad for the new text.

VBscript example

world.AppendToNotepad "Nick's window", "More stuff" + vbcrlf

Jscript example

world.AppendToNotepad("Nick's window", "More stuff\r\n");

PerlScript example

$world->AppendToNotepad("Nick's window", "More stuff\r\n");

Python example

world.AppendToNotepad("Nick's window", "More stuff\r\n")

Lua example

AppendToNotepad("Nick's window", "More stuff\r\n",
                "another line")

Lua notes

You can supply multiple arguments after the notepad name, which are concatenated together.

Return value

0: Could not do it.
1: Appended OK

Related topic

Notepad

See also