Skip navigation

FlexPro Documentation 2025

ParameterList

Returns the parameters of a data set as a list.

Syntax

ParameterList(DataSet [ , SortOrder = PARAMETERSORT_NONE ])

 

The syntax of the ParameterList function consists of the following parts:

Part

Description

DataSet

The data set whose parameters are returned.

All data structures are allowed. All data types are permitted.

If the argument is a list, then the function is executed for each element of the list and the result is also a list.

SortOrder

Specifies how the parameter names are sorted.

The argument SortOrder can have the following values:

Constant

Meaning

PARAMETERSORT_NONE

The parameters are returned in the order they have been saved.

PARAMETERSORT_ASCENDING

The parameters are returned so that the parameter names are sorted in ascending order.

PARAMETERSORT_DESCENDING

The parameters are returned so that the parameter names are sorted in descending order.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

If this argument is omitted, it will be set to the default value PARAMETERSORT_NONE .

Remarks

The result always has the data structure List.

The function returns the parameters of the data set as a list, sorted or unsorted. The parameter values can have units.

Available in

FlexPro View, Basic, Professional, Developer Suite

Examples

ParameterList(DataSet, PARAMETERSORT_ASCENDING)

Returns the parameters of the dataset ‘DataSet' as a list. The parameter names are sorted in ascending order.

See Also

NumberOfColumns Function

NumberOfElements Function

NumberOfRows Function

Rank Function

Shape Function