Name

remove_param — Remove a parameter and its associated value from a list of parameters

Calling Sequence

[param_list,err] = remove_param(list_name,param_name)

Parameters

list_name

the list of parameters. This list must have been initialize by a call to init_param.

param_name

a string. The name of the parameter to be removed from the list of parameters. If the parameter doesn't exist, nothing happens.

param_list

the updated list of parameters.

err

an error flag which is set to %T if list_name is not of type plist (this list hasn't been initialized by a call to init_param).

Description

This function allows to remove a parameter and its associated value from a list of parameters. If the err output parameter is not present, when an error occurs, a message is printed in the console.

Examples

 
mylist = init_param();
mylist = add_param(mylist,'minbound',[0 0 0]);
mylist = add_param(mylist,'maxbound',[0 0 0]);
mylist = remove_param(mylist,'minbound');

See Also

init_param , set_param , get_param , add_param , is_param

Authors

collette

ycollet@freesurf.fr