lr.save_string

Saves a null-terminated string to a parameter.

JavaScript

function lr.save_string(  param_value, param_name  )

VBScript

Function lr.save_string(  param_name, param_value  )
String and Parameter Functions

Arguments

NameComments
param_valueThe value to assign to the parameter.
param_nameThe name of the parameter.

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

Standard parameterization is not available for this function.

VBScript Example

In the following example, lr.save_string assigns "Wickham" to parameter"duty_officer"and"swing" to parameter "shiftName" . These parameters are then used in an output message.

lr.save_string "duty_officer", "Wickham"
lr.save_string "shiftName", "swing"
lr.output_message _
	(lr.eval_string _
	    ("The duty_officer for the <shiftName> shift is <duty_officer>."))
Example: Output: The duty_officer for the swing shift is Wickham.