lr_paramarr_idx

Returns the value of the parameter at a specified location in a parameter array.

C Language

char * lr_paramarr_idx( const char * paramArrayName, unsigned int index);
Example: lr_paramarr_idx and lr_paramarr_lenParameter Functions

Arguments

NameComments
paramArrayNameThe name of the parameter array from which to return the value.
indexThe one-based position of the parameter in the array.

lr_paramarr_idx retrieves a string containing the value of the parameter at the specified position in a parameter array. If the parameter does not exist, the return value is the concatenation of "{", paramArrayName, "_", index, and "}", for example, "{myParam_4}".

Return Values

A pointer to a string buffer containing the value. On error, it returns NULL.

Note: This function allocates memory internally. The memory is automatically freed at the end of each iteration.

Parameterization

Standard parameterization is not available for this function.

Concept Link IconSee Also