MUSHclient scripting

Description of MUSHclient world function: world.GetNotepadLength

Name	GetNotepadLength
Type	Method
Summary	Gets the length of the text in a notepad window
Prototype	`long GetNotepadLength(BSTR Title);` View list of 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. Note: Available in version 3.40 onwards.
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"))`
Returns	`The length of the text in the specified notepad, in characters. If that notepad does not exist, zero 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
GetNotepadList	Gets the list of open notepads - returning their titles
GetNotepadText	Gets the text from a 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

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.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.