world.ReplaceNotepad

MUSHclient script function (Method)

Replaces text in a notepad window

Prototype

boolean ReplaceNotepad(BSTR Title, BSTR Contents);

Data type meanings

Description

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

The function "ReplaceNotepad" 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).

VBscript example

world.ReplaceNotepad "Nick's window", "New contents" + vbcrlf

Jscript example

world.ReplaceNotepad("Nick's window", "New contents\r\n");

PerlScript example

$world->ReplaceNotepad("Nick's window", "New contents\r\n");

Python example

world.ReplaceNotepad("Nick's window", "New contents\r\n")

Lua example

ReplaceNotepad("Nick's window", "New contents\r\n")

Lua notes

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

Return value

0: Could not do it.
1: Replaced OK

Related topic

Notepad

See also