f$GetParameter (f$LiesParameter)
f$GetParameter (f$LiesParameter)
This function reads the value of a parameter and writes the result onto another parameter of string type. If the parameter to be read is not of string type, a data type conversion is carried out independently. Numbers are presented with a period as decimal separator. 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 source 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 the internal buffer, which can be entered with the f$ReadXMLFile function, is used. This buffer is used with the Execute method from the ePOS COM components. If the XML buffer is to be written onto a file for testing purposes, the buffer can be transferred to any ePOS parameter with f$GetParameter and subsequently written into a file.
Syntax: | Status = f$GetParameter(ParaName,NameParaValue) | ||
| Argument | Type | Meaning |
| ParaName | String | Name of the parameter |
| NameParaValue | String | Name of the parameter onto which the source parameter value is written. |
Result: | Integer | 0: parameter successfully read | |
Example: | Status = f$GetParameter('Address.PreferredName','Text') The content of Address.PreferredName is written onto the parameter: Text | ||