lr.save_string

Saves a null-terminated string to a parameter.

int lr.save_string( String param_value , String param_name);
String and Parameter FunctionsJava Syntax

Arguments

NameComments
param_value The value to assign to the parameter.
param_name The name of the parameter. (Case sensitive)

The lr.save_string function assigns the specified null-terminated string to a parameter. This function is useful in correlating queries. To determine the value of the parameter, use the lr.eval_string function.

Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure.

Parameterization

You cannot use standard parameterization for any arguments in this function.

Example

In the following example, lr.save_string assigns John Doe to the parameter Student. This parameter is then used in an output message. 

lr.save_string("John Doe" , "Student" );
    // ...
lr.message("Get report card for " + lr.eval_string("<Student>") );
Example: Output:
    Notify: Saving Parameter "Student = John Doe"
    Notify: Parameter Substitution: parameter "Student" = "John Doe"
    Get report card for John Doe