f$SetParameter (f$SetzeParameter)
f$SetParameter (f$SetzeParameter)
This function sets the value of a parameter from a string. If the parameter is not of string type, a data type conversion is performed independently. Numbers with a period as decimal separator are expected. If the parameter does not exist, the interpretation does not end and simply an appropriate status is returned.
The difference to a direct parameter allocation is that you do not have to worry about the target parameter data type and that there is no syntax problem if a parameter is not present.
This function is particularly suited to accessing a parameter indirectly, e.g. if a parameter name is read out of an Excel table, or in a function that processes all parameters in a parameter group.
If the character ’-’ is entered as the name of the parameter, then the content of Paravalue is written onto the internal buffer which can be entered with the f$ReadXMLFile function.
Syntax: | Status = f$SetParameter(ParaName,Paravalue) | ||
| Argument | Type | Meaning |
| ParaName | String | Name of the parameter |
| Paravalue | String | Value of the parameter. If an empty string has been entered, the destination parameter is set to NOVAL. |
Result: | Integer | 0: parameter has been labelled successfully | |
Example: | Status = f$SetParameter ('Address.PreferredName','ACBIS') | ||