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

OpenBrowser

Script function

world.OpenBrowser

Read about scripting

Type

Method

Summary

Opens a supplied URL in your default web browser

Prototype

long OpenBrowser(BSTR URL);

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:


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

View list of return code meanings

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)

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.

[Home]


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]