CloseNotepad
Script function

world.CloseNotepad

DOC_scripting Read about scripting

Type

Method

Summary

Closes a notepad window

Prototype

long CloseNotepad(BSTR Title, BOOL QuerySave);

DOC_data_types View list of data type meanings

Description

This closes a notepad window.

Title - title of the notepad (used in functions like AppendToNotepad)

QuerySave - whether to query to save changes, if the contents of the window have changed.

VBscript example

world.CloseNotepad "my_notepad", 0


Jscript example

world.CloseNotepad ("my_notepad", 0);


PerlScript example

$world->CloseNotepad ("my_notepad", 0);


Python example

world.CloseNotepad ("my_notepad", 0)


Lua example

CloseNotepad ("my_notepad", 0)


Lua notes

The QuerySave argument is optional, and defaults to false.


Return value

1 = closed OK
0 = not closed



See Also ...

Topic

DOC_notepad Notepad

Functions

FNC_ActivateNotepad ActivateNotepad (Activates a notepad window)
FNC_AppendToNotepad AppendToNotepad (Appends text to a notepad window)
FNC_GetNotepadLength GetNotepadLength (Gets the length of the text in a notepad window)
FNC_GetNotepadText GetNotepadText (Gets the text from a notepad window)
FNC_MoveNotepadWindow MoveNotepadWindow (Move and resize the specified notepad window)
FNC_NotepadColour NotepadColour (Changes the text and background colour of the selected notepad window)
FNC_NotepadFont NotepadFont (Changes the font and style of the selected notepad window)
FNC_NotepadSaveMethod NotepadSaveMethod (Changes the save method for this notepad window)
FNC_ReplaceNotepad ReplaceNotepad (Replaces text in a notepad window)
FNC_SaveNotepad SaveNotepad (Saves a notepad window to disk)
FNC_SendToNotepad SendToNotepad (Creates a notepad and sends text to it)

(Help topic: function=CloseNotepad)

DOC_contents Documentation contents page