Next: PAR_MAXx - Sets a maximum value for a parameter
Up: Reference Manual
Previous: PAR_GRMVx - Obtains from a parameter a vector of values each within a given range
PAR_GTD0L
- Obtains a logical value from a parameter with a dynamic
default
- Description:
This routine obtains a scalar logical value from a parameter.
A dynamic default is defined.
- Invocation:
CALL PAR_GTD0L( PARAM, DEFAUL, NULL, VALUE, STATUS )
- Arguments:
-
PARAM = CHARACTER * ( * ) (Given)
-
The name of the parameter.
-
DEFAUL = LOGICAL (Given)
-
The suggested default value for the parameter.
-
NULL = LOGICAL (Given)
-
NULL controls the behaviour of this routine when the parameter
is in the null state. If NULL is .FALSE., this routine
returns with STATUS=PAR__NULL. If NULL is .TRUE., the
returned VALUE takes the value of DEFAUL and, if the
MSG filtering level
is `verbose',
a message informs the user of the value used for
the parameter. The routine then returns with STATUS=SAI__OK.
This feature is intended for convenient handling of null values.
NULL should only be set to .TRUE. when the value of DEFAUL will
always give a reasonable value for the parameter.
-
VALUE = LOGICAL (Returned)
-
The value associated with the parameter. It will only be
valid if STATUS is not set to an error value.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
Next: PAR_MAXx - Sets a maximum value for a parameter
Up: Reference Manual
Previous: PAR_GRMVx - Obtains from a parameter a vector of values each within a given range
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