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

CloseNotepad

Script function

world.CloseNotepad

Read about scripting

Type

Method

Summary

Closes a notepad window

Prototype

long CloseNotepad(BSTR Title, BOOL QuerySave);

View list of 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.


Available in MUSHclient 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.


Return value

1 = closed OK
0 = not closed


See Also ...

Topic

Notepad

Functions

(ActivateNotepad) Activates a notepad window
(AppendToNotepad) Appends text to a notepad window
(GetNotepadLength) Gets the length of the text in a notepad window
(GetNotepadList) Gets the list of open notepads - returning their titles
(GetNotepadText) Gets the text from a notepad window
(MoveNotepadWindow) Move and resize the specified notepad window
(NotepadColour) Changes the text and background colour of the selected notepad window
(NotepadFont) Changes the font and style of the selected notepad window
(NotepadReadOnly) Make a selected notepad window read-only
(NotepadSaveMethod) Changes the save method for this notepad window
(ReplaceNotepad) Replaces text in a notepad window
(SaveNotepad) Saves a notepad window to disk
(SendToNotepad) Creates a notepad and sends text to it

(Help topic: function=CloseNotepad)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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]