hiLaunchBrowser

hiLaunchBrowser(
t_url
[ g_browserHint ]
)
=> t / nil

Description

Starts a Web browser, if needed, and opens the URL you specify.

If a browser window is already open, hiLaunchBrowser uses that browser and opens the specified URL in a new or existing window or tab, based on the value of the g_browserHint argument. If a browser is not already open, hiLaunchBrowser starts the browser specified in the Web Browser field of the User Preferences form.

The User Preferences form contains the value of the ui webBrowser variable set in the registry or custom .cdsenv file. (If you make a change in the form and save your defaults, the .cdsenv file is updated.)

If a CDS_DEFAULT_BROWSER environment variable is set, Virtuoso applications, when they start, they set the value of that variable in the User Preferences form (overriding the value read from the .cdsenv file). Therefore, that value is used by hiLaunchBrowser.

hiLaunchBrowser checks for and launches only Mozilla-based browsers: Netscape, Firefox, and Mozilla.

Arguments

t_url

The URL that you want the browser to display, specified as a string.

g_browserHint

One of the following symbols, specifying where to open the URL:

'newWindow: Opens URL in a new window.

'newTab: Open URL in a new tab.

'newLocation: Open URL in an existing window and tab.

Default value: 'newLocation

Values Returned

`t`	The browser was started.
`nil`	There was an error.

Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023