Scilab Home page | Wiki | Bug tracker | Forge | Mailing list archives | ATOMS | File exchange
Please login or create an account
Change language to: English - Français - Português - 日本語 -
Справка Scilab >> Parameters > remove_param

remove_param

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

Syntax

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

Arguments

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 does not 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 has not 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 — Initialize the structure which will handles the parameters list
  • set_param — Set the value of a parameter in a parameter list
  • get_param — Get the value of a parameter in a parameter list
  • add_param — Add a parameter to a list of parameters
  • is_param — Check if a parameter is present in a parameter list
Scilab Enterprises
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Tue Feb 14 15:13:26 CET 2017