Navigation: Scripting Reference Manual > Functions & Subroutines > DeleteConfigVariable

 

DeleteConfigVariable

 

Contact Us: fredsupport@photonengr.com

 

Description

This command deletes the configuration variable at the designated index.

 

 

Syntax

varCount = DeleteConfigVariable( varIndex )

 

 

Parameters

varCount (Long)

Returned number of remaining configuration variables after deletion.

 

varIndex As Long

Index of the configuration variable being deleted.

 

 

Example

The following example loops over all configuration variables and deletes them from the configuration list.

 

Sub Main

 

    Dim curConfigVar As Long, varCount As Long

    varCount = GetConfigVariableCount()

    For curConfigVar = varCount-1 To 0 Step -1

        Print "Number vars: " & Chr(9) & varCount

        varCount = DeleteConfigVariable( curConfigVar )

    Next curConfigVar

    Print "Number vars: " & Chr(9) & varCount

 

End Sub

 

 

See Also

Configuration Script Commands

T_CONFIGURATION

 

 

 

 

 

Copyright © Photon Engineering, LLC