Get a vector value from a KeyMap astMapGet1X
"
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 astMapGet1C function has an extra
parameter "
l"
which specifies the maximum length of each string to be stored in
the "
value"
buffer (see the "
astMapGet1C"
section below). "
value"
array. "
value"
array. Any
unused elements of the array are left unchanged. Zero is returned if the required
KeyMap entry has an undefined value. No error is reported if the requested key cannot be found in the given KeyMap, but a zero value will be returned as the function value. The supplied array will be returned unchanged.
If the stored value is a scalar value, then the value will be returned in the first element
of the supplied array, and "
nval"
will be returned set to 1.
"
value"
buffer supplied to the astMapGet1C function should be a pointer to a character array with
"
mxvall"
elements, where "
l"
is the maximum length of a string to be returned. The
value of "
l"
should be supplied as an extra parameter following "
key"
when
invoking astMapGet1C, and should include space for a terminating null character.
D: double
F: float
I: int
K: int64_t
C: "
const"
pointer to null terminated character string
A: Pointer to AstObject
P: Generic "
void "
pointer
S: short int
B: Unsigned byte (i.e. char)
For example, astMapGet1D would be used to get "
double"
values, while astMapGet1I would
be used to get "
int"
values, etc. For D or I, the supplied "
value"
parameter should
be a pointer to an array of doubles or ints, with "
mxval"
elements. For C, the
supplied "
value"
parameter should be a pointer to a character string with "
mxvall"
elements. For A, the supplied "
value"
parameter should be a pointer to an array of
AstObject pointers.