activeServer

Syntax

Session.activeServer;

Access

readonly

Parameters

Return value string

The display name of the active serer.

Description

The activeServer property is used to get the display name of the server used for the current session. It returns empty when not logged in. The name of the server will have the value of the name property of the <SCEnt:ServerInfo/> tag in the WWSettings.xml file.

For more info about the Session object please see the entSession documentation.

Examples

Get the server name used for the current session

When activeServer is empty, there is no active session.

// Get the server name used for the current session.
var sessionObject = app.entSession;
var serverName = sessionObject.activeServer;

// Given in WWSettings '<SCEnt:ServerInfo name="Studio v10.5.0" url="https://server.company.net/studio/index.php"/>'
// serverUrl is now 'Studio v10.5.0'.

Supported versions

See also

• entSession