Get a scalar value from a KeyMap AST_MAPGET0X
"
Data Type Codes"
section below for the code
appropriate to each supported data type). The stored value is converted to the data type indiced by
X
before being returned (an error is reported if it is not possible to convert the stored value to
the requested data type). Note, the version of this function which returns character
strings, AST_MAPGET0C, has an extra parameter in which is returned the number of
characters written into the supplied CHARACTER variable. RESULT = AST_MAPGET0C( THIS, KEY, VALUE, L, STATUS )
No error is reported if the requested key cannot be found in the given KeyMap, but a .FALSE. value will be returned as the function value. The supplied buffer will be returned unchanged.
If the stored value is a vector value, then the first value in the vector will be returned.
If the returned value is an AST Object pointer, the Object’
s reference count is incremented by this call.
Any subsequent changes made to the Object using the returned pointer will be reflected in any any other
active pointers for the Object. The returned pointer should be annulled using AST_ANNUL when it is
no longer needed.
D: DOUBLE PRECISION
R: REAL
I: INTEGER
C: CHARACTER
A: INTEGER used to identify an AstObject
S: INTEGER2 (short integer)
B: Unsigned byte
For example, AST_MAPGET0D would be used to get a DOUBLE PRECISION value, while AST_MAPGET0I would be used to get an INTEGER, etc.