Deletes a dynamic parameter at runtime, freeing its buffer.

C Language

int lr_free_parameter( const char *param );

Example: lr_free_parameterParameter Functions


param The name of the dynamic parameter.

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

lr_free_parameter frees the memory for parameters created at runtime using functions such as web_reg_save_param or lr_save_string. For other functions that create parameters at runtime, see the Parameter Functions and the Web Correlation Functions for C. For similar functions in other protocols, see the reference for the specific protocol.

Return Values

This function returns 0 if it succeeds. Success means that both of the following are true:

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

Otherwise, the function returns a negative number.


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