next up previous
Next: About this document ...
Up: Reference Manual
Previous: PAR_STATE - Inquires the state of a parameter

PAR_UNSET - Cancels various parameter control values.    

Description:
This routine cancels one or more control values of a parameter. These are currently the parameter's dynamic default value (set by PAR_DEFnx or DAT_DEF), its minimum value (set by PAR_MINx), its maximum value (set by PAR_MAXx), or its prompt string (set by PAR_PROMT).

The routine will operate regardless of the given STATUS value and will not report or set STATUS if the specified values have not been set or are already cancelled.

Invocation:
CALL PAR_UNSET( PARAM, WHICH, STATUS )

Arguments:
PARAM = CHARACTER*(*) (Given)
The name of the parameter.
WHICH = CHARACTER*(*) (Given)
A comma-separated list of the control values to be cancelled, selected from the following options:
  • 'DEFAULT' to cancel the dynamic default,
  • 'MAXIMUM' to cancel the maximum value, and
  • 'MINIMUM' to cancel the minimum value.
Unambiguous abbreviations are permitted.
STATUS = INTEGER (Unused)
The global status. The routine is executed regardless of the import value of STATUS. If the import value is not SAI__OK, then it is left unchanged, even if the routine fails to complete. If the import value is SAI__OK on entry and the routine fails to complete, STATUS will be set to an appropriate value.



next up previous
Next: About this document ...
Up: Reference Manual
Previous: PAR_STATE - Inquires the state of a parameter

PAR Interface to the ADAM Parameter System
Starlink User Note 114
Malcolm J. Currie
Alan J. Chipperfield
1999 September 24
E-mail:ussc@star.rl.ac.uk