GetConfiguration

(Engine-Level Function)

Description: Returns the configuration parameters from the license key for this copy of VTScada.
Returns: Numeric
Usage: Script or steady state.
Function Groups: Software and Hardware
Related to: SerialNum
Format: GetConfiguration(Option)
Parameters:  
Option
Required. Selects the configuration item for which information is required. See the following table:
(GetConfiguration returns Invalid for any value outside the range shown. )

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.
(Must be handed to the Date function for a human-readable format.)

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 = Configuration. 3 = View Mode)

6

Reserved

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). VTScada client systems installed with this license may only connect to servers with the same serial number. If FALSE (0), VTScada client systems installed with this license may connect to any server.

9

The VTScada Alarm Notification System is an option controlled by the installation key in VTScada versions 7.1 and later. Option 9 returns the status of this enable - TRUE if the Alarm Notification System is supported. FALSE if the Alarm Notification System is not supported.

10

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

11

Not used.

12

Returns 1 if Remote Data Access is enabled. 0 if not

13

Not used.

14

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

15

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

16

Returns 1 if the key enables the Show Version Control option in the Application Properties Dialog

17Returns 1 if Synchronized Configuration is enabled
18Returns 1 if Application RPC Services are enabled
19Returns 1 if machine is an RPC Server
20Reserved
21IVONA (Deprecated)
22Reserved
23Returns the installation key evaluation period type, as follows:
  0 - unlimited
  1 - 30 days from install
  2 - 90 days from install
  3 - same as maintenance expiration
24Reserved
25Returns the location of the VTScada executable
26Returns TRUE if the Remote Idea Studio is enabled. (VIC use only)
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 VTScada. GetConfiguration(0) is identical to the function SerialNum() and is preferred for all new code.

Example:

The following could be added to an administrative page in an application. While the example shows English text, a phrase key should be used in practice.

  GUIText(57, 126, 245, 106,
          1, 1, 1, 1, 1 { Scaling              },
          0, 0          { Movement             },
          1, PickValid(\ScaleDisplayContent, 0) { Visibility, Font Scaling },
          0, 0, 0       { Selectability        },
          Brush("<00000000>", 0, 1), Pen("<FF000000>", 1, 1),
          Scope(VTSDB, "LabelFont", TRUE)\Value,
          0, 4,
          "%s",
          Concat("Remember to renew by ", Date(GetConfiguration(2), 4)));