world.CloseNotepad

MUSHclient script function (Method) — introduced in version 3.29

Closes a notepad window

Prototype

long CloseNotepad(BSTR Title, BOOL QuerySave);

Data type meanings

Description

This closes a notepad window.

Title - title of the notepad (used in functions like AppendToNotepad)

QuerySave - whether to query to save changes, if the contents of the window have changed.

VBscript example

world.CloseNotepad "my_notepad", 0

Jscript example

world.CloseNotepad ("my_notepad", 0);

PerlScript example

$world->CloseNotepad ("my_notepad", 0);

Python example

world.CloseNotepad ("my_notepad", 0)

Lua example

CloseNotepad ("my_notepad", 0)

Lua notes

The QuerySave argument is optional, and defaults to false.

Return value

1 = closed OK
0 = not closed

Related topic

Notepad

See also