Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.GetClipboard


Name GetClipboard
Type Method
Summary Gets the clipboard contents
Prototype BSTR GetClipboard();
Description

Returns the clipboard contents, if the clipboard contains straight text. If there is no text on the clipboard, it returns the empty string.


Note: Available in version 3.39 onwards.


VBscript example
Note GetClipboard
Jscript example
Note (GetClipboard ());
PerlScript example
Note (GetClipboard ());
Python example
world.Note (world.GetClipboard)
Lua example
Note (GetClipboard ())
Returns The clipboard contents, of an empty string if the clipboard does not contain text.
Introduced in version 3.39

See also ...

Function Description
SetClipboard Sets the clipboard contents

Search for script function

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.

Search for:   

Leave blank to show all functions.


Return codes

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

You can view a list of the return codes


Function prototypes

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

You can view a list of the data types used in function prototypes


View all functions

[Back]

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