Navigation: Scripting Reference Manual > Functions & Subroutines > GetConfigVariable

 

GetConfigVariable

 

Contact Us: fredsupport@photonengr.com

 

Description

This command retrieves the configuration variable from the designated index and sets the values to a T_CONFIGURATION data structure.

 

 

Syntax

GetConfigVariable varIndex, tConfigVar

 

 

Parameters

varIndex As Long

Index (0 based) into the configuration variable list whose T_CONFIGURATION data is being retrieved.

 

tConfigVar As T_CONFIGURATION

Data structure whose member values are set according to the configuration variable definition at index varIndex.

 

 

Example

The following script loops over all configuration variables and prints their definitions to the output window.

 

Sub Main

 

    ClearOutputWindow()

 

    Dim tConfigVar As T_CONFIGURATION

    Dim curVariable As Long, curConfig As Long

    For curVariable = 0 To GetConfigVariableCount()-1

        GetConfigVariable curVariable, tConfigVar

        Print "Configuration Variable " & curVariable & ":"

        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) & "Sub-index: " & Chr(9) & tConfigVar.subindex

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

        Print Chr(9) & "Values: "

        For curConfig = 0 To GetConfigCount()-1

             Print Chr(9) & Chr(9) & "Config " & curConfig & Chr(9) & tConfigVar.values(curConfig)

        Next curConfig

    Next curVariable

 

End Sub

 

 

See Also

Configuration Script Commands

T_CONFIGURATION

 

 

 

 

 

Copyright © Photon Engineering, LLC