world.GetNotepadText

MUSHclient script function (Method) — introduced in version 3.40

Gets the text from a notepad window

Prototype

BSTR GetNotepadText(BSTR Title);

Data type meanings

Description

Returns the text from the specified notepad window.

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

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"))

Return value

The text from the specified notepad window.

If that notepad does not exist, an empty string is returned.

Related topic

Notepad

See also