lr.eval_string

Returns the string argument after evaluating embedded parameters.

C#

string lr.eval_string( string instring );

VB.NET

Function lr.eval_string( ByVal instring  As String ) as String
String and Parameter Functions

Arguments

NameComments
instringThe string to evaluate.

The lr.eval_string function returns the input string after evaluating any embedded parameters. If the string argument contains only a parameter, the function returns the current value of the parameter.

Parameters must be in parameter brackets.

Return Values

The input string, expanded to include the values of any parameters.

Parameterization

All string input arguments can be passed using standard parameterization.

Example

In the this example, there is a parameter, <iteration> that reports the iteration number of the test. The lr.error_message function sends a message indicating the current iteration number. The lr.error_message step includes a lr.eval_string call to convert the iteration number to a string.

 
if (status == lr.FAIL) {
    lr.error_message( "Error at iteration #" + 
        lr.eval_string( "{iteration}" ) );
    return -1;
}
return 0;