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


Script function


Read about scripting




Creates a notepad and sends text to it


boolean SendToNotepad(BSTR Title, BSTR Contents);

View list of data type meanings


Creates a notepad window with the nominated title and contents.

The contents are copied "as is" without a trailing newline. If you want a newline you will need to add it yourself. The built-in constant "vbcrlf" can be used for this purpose in Visual Basic.

VBscript example

world.SendToNotepad "Nick's window", "Hello, world" & _
              vbcrlf & "another line"

Jscript example

world.SendToNotepad("Nick's window", 
                    "Hello, world\r\nanother line")

PerlScript example

$world->SendToNotepad("Nick's window", 
                  "Hello, world\r\nanother line");

Python example

world.SendToNotepad("Nick's window", 
                    "Hello, world\r\nanother line")

Lua example

SendToNotepad ("Nick's window", 
               "Hello, world\r\nanother line")

Lua notes

You can supply multiple arguments after the notepad name, which are concatenated together.

Return value

0: Window not created.
1: Window created OK

See Also ...




(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
(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

(Help topic: function=SendToNotepad)

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.


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]