Skip to the navigation links
Last modified: December 2009

URL: http://cxc-newtest.cfa.harvard.edu/ciao4.2/paramio_punlearn.html
AHELP for CIAO 4.2

punlearn

Context: paramio

Synopsis

Restore the system defaults for a parameter file from S-Lang.

Syntax

punlearn( paramfilespec )

Description

This function is essentially the same as the command-line version (see "ahelp tools punlearn").

The paramio module is not available by default; to use it in a S-Lang program, it must be loaded using the S-Lang require() function:

  require("paramio");

The input value can be one of:

  • a string containing a single name
  • a string containing multiple names, each separated by a space or a comma
  • an array of strings, each string being the name of a single parameter file

Note that punlearn() does not accept a Param_File_Type variable - i.e. the output of paramopen().

As with all the paramio routines, the PF_Errno variable is set to 0 on success, or on error it is set to one of the error codes listed in the paramio documentation.

Example

slsh> require("paramio");
slsh> punlearn("dmextract");
slsh> punlearn("dmextract dmlist");
slsh> punlearn("dmextract dmlist, dmcopy");
slsh> punlearn(["dmextract","dmlist","dmcopy"]);

This example shows the different ways that punlearn() can be used.

Bugs

See the bugs page for the paramio module on the CIAO website for an up-to-date listing of known bugs.

See Also

concept
parameter
modules
paramio
paramio
paccess, paramclose, paramopen, pget, pgets, plist_names, pquery, pset
tools
dmhistory, dmkeypar, dmmakepar, dmreadpar, paccess, pdump, pget, pline, plist, pquery, pset, punlearn

Last modified: December 2009