Navigation: Scripting Reference Manual > Functions & Subroutines > GetConfigValue

 

GetConfigValue

 

Contact Us: fredsupport@photonengr.com

 

Description

This command retrieves the configuration variable value for a given configuration.

 

 

Syntax

configValue = GetConfigValue( varIndex, configIndex )

 

 

Parameters

configValue (Double)

Returned configuration value.

 

varIndex As Long

Index of the variable whose value in configuration configIndex is being retrieved.

 

configIndex As Long

Index of the configuration for which the variable value is being retrieved.

 

 

 

Example

The following example retrieves and displays the variable values for all variables and configurations.

 

Sub Main

 

    ClearOutputWindow

 

    Dim numConfigs As Long, curConfig As Long

    numConfigs = GetConfigCount()

 

    'Print header line

    Print Chr(9);

    For curConfig = 0 To numConfigs-1

        If curConfig = numConfigs-1 Then

            Print "Config " & curConfig

        Else

            Print "Config " & curConfig;

        End If

    Next curConfig

 

    Dim numVars As Long, curVar As Long

    Dim tConfigVar As T_CONFIGURATION

    numVars = GetConfigVariableCount()

    For curVar = 0 To numVars-1

        GetConfigVariable curVar, tConfigVar

        Print tConfigVar.Description;

        For curConfig = 0 To numConfigs-1

            If curConfig = numConfigs-1 Then

                Print GetConfigValue( curVar, curConfig )

            Else

                Print GetConfigValue( curVar, curConfig );

            End If

        Next curConfig

    Next curVar

 

End Sub

 

 

See Also

Configuration Script Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC