GetConfiguration

Description:              Returns the configuration parameters from the license key for this copy of VTS.

Returns:                    Numeric

Usage:                       Script or Steady State

Format:                      GetConfiguration(Option)

Parameters:             Option   { numeric }  { required }  { no default }

                                              Selects the configuration item for which information is required. See the following table:

 

Option

Configuration Item

0

Serial number of this copy of VTS

1

Number of hours for restricted run-time (0 if unrestricted)

2

Expiry date for free updates'

3

Number of tags permitted (or 0 if no limit)

4

Number of browser clients permitted

5

Run mode (0 = Full; 1 = Run-time; 2 = Toolbox; and 3 = View Mode)

6

Dongle required to run.

7

Returns the number of days remaining in the evaluation period. If this is not an evaluation license, then this option returns Invalid.

8

Returns the Client Connection Restriction. If True (1). VTS client systems installed with this license may only connect to servers with the same serial number. If False (0), VTS client systems installed with this license may connect to any server.

9

The VTScada Alarm Dialer is an option controlled by the installation key in VTS versions 7.1 and later. Option 9 returns the status of this enable – True if the Alarm Dialer is supported; False if the Alarm Dialer is not supported.

10

Returns the copyright statement built into VTS. The format of the returned text string is: "Copyright © 1988-2004 Trihedral Engineering Ltd"

11

Returns 1 if the WAP server is enabled. 0 if not

12

Returns 1 if WEB services are enabled. 0 if not

13

Returns 1 if the ODBC server is enabled. 0 if not

14

Returns 1 if the OPC server is enabled. 0 if not

15

Returns 1 if this installation is licensed to run 64-bit VTS. 0 if not

 

Comments:               If the license key information fails certain consistency checks, then this function returns Invalid for all values of Option.

                             This function can be used to determine license restrictions pertaining to the current copy of VTS. GetConfiguration(0) is identical to the function SerialNum() and is preferred for all new code.

See Also:

SerialNum