Navigation: Scripting Reference Manual > Functions & Subroutines > AddConfigVariable

 

AddConfigVariable

 

Contact Us: fredsupport@photonengr.com

 

Description

Adds a new configuration variable to the configuration list and returns the new variable's array index.

 

 

Syntax

newVarIndex = AddConfigVariable( tConfigVar )

 

 

Parameters

newVarIndex (Long)

Index in the configuration variable list at which the new variable was added.

 

tConfigVar As T_CONFIGURATION

Data structure containing the definition of the new configuration variable being added.

 

 

Example

The following script initializes a T_CONFIGURATION data structure and adds a new variable to the configuration list.

 

Sub Main

 

    Dim newVarIndex As Long

    Dim tConfigVar As T_CONFIGURATION

    InitConfigVariable tConfigVar

        Print "Configuration variable initialized."

        Print Chr(9) & "Description:" & Chr(9) & tConfigVar.Description

        Print Chr(9) & "Entity: " & Chr(9) & tConfigVar.entity

        Print Chr(9) & "Index: " & Chr(9) & tConfigVar.index

        Print Chr(9) & "Subindex: " & Chr(9) & tConfigVar.subindex

        Print Chr(9) & "Type: " & Chr(9) & tConfigVar.Type

    newVarIndex = AddConfigVariable( tConfigVar )

 

End Sub

 

 

See Also

Configuration Script Commands

T_CONFIGURATION

 

 

 

 

 

Copyright © Photon Engineering, LLC