world.GetNotepadLength

MUSHclient script function (Method) — introduced in version 3.40

Gets the length of the text in a notepad window

Prototype

long GetNotepadLength(BSTR Title);

Data type meanings

Description

Find the length of the text in the specified notepad window.

If a notepad of that name does not exist a length of zero is returned.

VBscript example

world.Note world.GetNotepadLength ("mynotes")

Jscript example

world.Note (world.GetNotepadLength ("mynotes"));

PerlScript example

Note (GetNotepadLength ("mynotes"));

Python example

world.Note (str (world.GetNotepadLength ("mynotes")));

Lua example

Note (GetNotepadLength ("mynotes"))

Return value

The length of the text in the specified notepad, in characters.

If that notepad does not exist, zero is returned.

Related topic

Notepad

See also