getDatasetValueByName

This feature was removed from Ignition in version 8.0.0

This function is used by Ignition's Expression language.

Description

note

This function is only available in Transaction Group Expression Items and Expression Tags.

Retrieves data from a global variable DatasetName created using the ExecuteQuery function.

Syntax

getDatasetValueByName(datasetName, row, column, fallback)

• Parameters

  • string datasetName - The name of the dataset created using the executeQuery function.

  • int row - The row index.

  • string column - The name of the column.

  • Object fallback - A fallback value if the lookup fails.

• Results

  • Object - The value at the given row index and column name. They type returned matches the type of the value selected.

Examples

For example, suppose you had a dataset called 'MyResult' with this information in it:

ProductCode	Quantity	Weight
BAN_002	380	3.243
BAN_010	120	9.928
APL_000	125	1.287
FWL_220	322	7.889

Code Snippet

getDatasetValueByName("MyResult", 0, "Quantity", -1)  //would return 380
getDatasetValueByName("MyResult", 1, "Weight", -1)  //would return 9.928
getDatasetValueByName("MyResult", 0, "Color", -1) //would return -1 because there is no Color column and it reverts to the fallback value.