f$defineparameter

f$DefineParameter

With this function, a parameter can be defined for runtime. This parameter can be part of a parameter group or 1-dimension. The parameter definition is always global. If the parameter is part of an indexed parameter group, the index is only evaluated with the first parameter in the group. All other parameters in the same parameter group always receive the same index. If the indexation of a parameter group is changed, the f$PGDimension function can be used.

Syntax:	Status = f$DefineParameter(PGName,PGIndex,ParaName,ParaIndex,ParaTyp,Format,Designation,Init)
	Argument	Type	Meaning
	PGName	String	Name of the parameter group or " for single parameter
	PGIndex	Integer	Index of the parameter group or 0 if the parameter group is not indexed
	ParaName	String	Name of the parameter
	ParaIndex	Integer	Index of the parameter or 0 if the parameter is not indexed
	ParaTyp	Integer	Type of parameter: 1 – string 2 – integer 3 – decimal
	Format	String	Format of the parameter or ''
	Designation	String	Designation of the parameter or ''
	Init	String	Initialization of the parameter. Decimal parameters must be entered with a period as decimal separator
Result:	Integer	0: everything ok -1: parameter already existed -2: parameter name is empty or invalid -3: parameter group name is invalid
Example:	Definition of a parameter group with index 10 with the decimal parameters Value and Factor as well as string parameter Designation Status = f$DefineParameter('PricePG',10,'Value',0,2,'#€','ListPrice','0') Status = f$DefineParameter('PricePG',10,'Factor',0,2,'','CountryFactor','1.5') Status = f$DefineParameter('PricePG',10,'Designation',0,1,'','','')