Script function

world.OpenBrowser

Type

Method

Summary

Opens a supplied URL in your default web browser

Prototype

long OpenBrowser(BSTR URL);

Description

Opens the URL you supply using the default web browser for this PC.

The URL must start with one of the following strings (not case-sensitive):

http://
https://
mailto:

Available in MUSHclient version 3.74 onwards.

VBscript example

OpenBrowser "http://www.mushclient.com"

Jscript example

OpenBrowser ("http://www.mushclient.com")

PerlScript example

$world->OpenBrowser ("http://www.mushclient.com");

Lua example

OpenBrowser ("http://www.mushclient.com")

Return value

eBadParameter - the URL was either empty or did not start with "http://", "https://", or "mailto:".

eCouldNotOpenFile - an error code was returned by Windows when attempting to open the web browser

eOK - successfully opened

See Also ...

Topics

Scripting
World functions

Functions

(GetWorld) Gets an object reference to the named world
(GetWorldById) Gets an object reference to the world given its unique ID
(GetWorldIdList) Gets the list of open worlds - returning their world IDs
(GetWorldList) Gets the list of open worlds - returning their world names
(Open) Opens a named document

(Help topic: function=OpenBrowser)