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

MUSHclient scripting

Description of MUSHclient world function: world.CloseNotepad

Name CloseNotepad
Type Method
Summary Closes a notepad window
Prototype long CloseNotepad(BSTR Title, BOOL QuerySave);

View list of data type meanings


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.

Note: Available in version 3.29 onwards.

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.
Returns 1 = closed OK
0 = not closed
Introduced in version 3.29

See also ...

Function Description
ActivateNotepad Activates a notepad window
AppendToNotepad Appends text to a notepad window
GetNotepadList Gets the list of open notepads - returning their titles
ReplaceNotepad Replaces text in a notepad window
SaveNotepad Saves a notepad window to disk
SendToNotepad Creates a notepad and sends text to it

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


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.


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]