lr.freeParameter

Deletes a dynamic parameter at runtime, freeing its buffer.

Syntax

lr.freeParameter( param );

Arguments

The lr.freeParameter function frees the memory allocated at runtime for the specified parameter.

lr.freeParameter frees the memory for parameters created at runtime using functions such as web.regSaveParam or lr.saveString. For other functions that create parameters at runtime, see the String and Parameter Functions and the Web Correlation Functions for JavaScript. For similar functions in other protocols, see the reference for the specific protocol.

Return Values

On success, returns 0. Success means that the following are true:

• The dynamic parameter by the specified name is found.
• The memory allocated for the dynamic parameter is freed successfully.

Otherwise, returns a negative number.

Parameterization

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

Example

lr.freeParameter("Name");