Get a scalar value from a KeyMap astMapGet0X
"
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). "
A"
and
"
C"
), the buffer should be a suitable pointer, and the address of this
pointer should be supplied as the "
value"
parameter. 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 buffer will be returned unchanged.
If the stored value is a vector value, then the first value in the vector will be returned.
A string pointer returned by astMapGet0C is guaranteed to remain valid and the string to which it points will not be over-written for a total of 50 successive invocations of this function. After this, the memory containing the string may be re-used, so a copy of the string should be made if it is needed for longer than this. The calling code should never attempt to free the returned pointer (for instance, using astFree).
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 astAnnul when it is no longer needed.
F: float
D: double
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. word)
For example, astMapGet0D would be used to get a "
double"
value, while astMapGet0I
would be used to get an "
int"
, etc.