ParameterGet

Gets the value of a parameter. The parameter can exist in a local Citect.ini file, a profile INI file, or the parameters database.

• If a project is using a profile INI file, the value of the specified parameter will be retrieved from the profile INI.

• If the specified parameter exists in both Citect.ini and the parameters database, the value of the parameter is retrieved from the Citect.ini.

• If the parameter does not exist in any of these locations, the default value is returned.

Syntax

ParameterGet(Section, Name, Default)

Section:

The section name.

sName:

The parameter name.

Default:

The default value of the parameter.

Note: If in your Cicode you perform a ParameterGet("alarm", "saveperiod", 1000) for the [Alarm]SavePeriod parameter, and no entry exists in the profile INI file, the Citect.ini or the parameters records, the returned value will be 1000. However Plant SCADA will internally be using the default value of 600.

Return Value

The parameter (as a string).

Related Functions

ParameterPut, WndGetFileProfile, WndPutFileProfile

Example

Variable=ParameterGet("Page","Windows","4");

See Also

Miscellaneous Functions