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

MUSHclient scripting

Description of MUSHclient world function: world.GetNotepadText

Name GetNotepadText
Type Method
Summary Gets the text from a notepad window
Prototype BSTR GetNotepadText(BSTR Title);

View list of data type meanings


Returns the text from the specified notepad window.

If a notepad of that name does not exist an empty string is returned.

Note: Available in version 3.40 onwards.

VBscript example
world.Note world.GetNotepadText("mynotes")
Jscript example
world.Note (world.GetNotepadText ("mynotes"));
PerlScript example
Note (GetNotepadText ("mynotes"));
Python example
world.Note (world.GetNotepadText ("mynotes"))
Lua example
Note (GetNotepadText ("mynotes"))
Returns The text from the specified notepad window.

If that notepad does not exist, an empty string is returned.
Introduced in version 3.40

See also ...

Function Description
Activate Activates the world window
ActivateNotepad Activates a notepad window
AppendToNotepad Appends text to a notepad window
CloseNotepad Closes a notepad window
GetNotepadLength Gets the length of the text in 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]