Utility Functions and C Language Reference > Utility Functions: Scripting Languages (lr.) > Alphabetical Listing > lr.next_row

lr.next_row

Advances to the next row in the parameter data file.

JavaScript

function lr.next_row( dat_file )

VBScript

Function lr.next_row( dat_file )

Example: lr.next_row String and Parameter Functions

Arguments

Name Comments
dat_file The name of the parameter .dat file containing the values you want to retrieve.

The lr.next_row function sets the active row to be the next row in the specified parameters file. If the current row is the last, lr.next_row sets the active row to the first row.

Use this function within an iteration, to advance to the next set of values. If you want the active row to advance at the beginning of each iteration, you do not need this function: In the parameter properties, you can specify to advance to the next row for each iteration.

This function is most useful with Table parameters. If you specify more than one parameter in a file, lr.next_row advances the values for all the parameters. This is the natural way to advance Table rows.

To advance only one parameter in a file, use lr.advance_param with Select next row set to sequential in the parameter properties.

Note that the dat file name is by default the name of a parameter, unless you specified a different name for the file when you defined the parameter. For example, the dat file for the IDs parameter, is IDs.dat.

Return Values

Returns 0 on success and -1 on failure.

Parameterization

Standard parameterization is not available for this function.