Skip to main content
Skip table of contents

f$GetParameterFormat (f$LiesParameterFormat)

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 using the parameter's formatting instructions or using the regional settings if there is no formatting instruction present. 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.

Syntax:

Status = f$GetParameterFormat(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
–1: the source parameter is UNDEF
–2: the source parameter does not exist

Example:

Status = f$GetParameterFormat('Address.FreeDouble1','Text')

The content of Address.FreeDouble1 is written onto the parameter: Text

Text = '12.50 €'

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.