Next: PAR_GDR0x - Obtains a scalar value within a given range from a parameter
Up: Reference Manual
Previous: PAR_DEFNx - Sets an array of values as the dynamic default for a parameter
PAR_EXACx
- Obtains an exact number of values from a parameter
- Description:
This routine obtains an exact number of values from a parameter
and stores them in a vector. If the number of values obtained
is less than that requested, a further get or gets will occur
for the remaining values until the exact number required is
obtained (or an error occurs). The routine reports how many
additional values are required prior to these further reads.
Should too many values be entered an error results and a further
read is attempted.
- Invocation:
CALL PAR_EXACx( PARAM, NVALS, VALUES, STATUS )
- Arguments:
-
PARAM = CHARACTER * ( * ) (Given)
-
The name of the parameter.
-
NVALS = INTEGER (Given)
-
The number of values needed. Values will be requested until
exactly this number of values (no more and no less) has been
obtained.
-
VALUES( NVALS ) = ? (Returned)
-
The values obtained from the parameter system. They will only
be valid if STATUS is not set to an error value.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
-
There is a routine for each of the data types character,
double precision, integer, logical, and real: replace "x" in the
routine name by C, D, I, L, or R respectively as appropriate. The
VALUES argument must have the corresponding data type.
-
If more than one attempt is made is to obtain the values, the
current value of the parameter will be only that read at the
last get, and not the full array of values.
-
A PAR__ERROR status is returned when the number of values
requested is not positive.
Next: PAR_GDR0x - Obtains a scalar value within a given range from a parameter
Up: Reference Manual
Previous: PAR_DEFNx - Sets an array of values as the dynamic default for 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