OpenBrowser
Script function

world.OpenBrowser

DOC_scripting Read about scripting

Type

Method

Summary

Opens a supplied URL in your default web browser

Prototype

long OpenBrowser(BSTR URL);

DOC_data_types View list of data type meanings

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:

VBscript example

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


Jscript example

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


PerlScript example

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


Lua example

eOK


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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_scripting Scripting
DOC_world World functions

Functions

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

(Help topic: function=OpenBrowser)

DOC_contents Documentation contents page