next up previous 264
Next: AST_MARK - Draw a set of markers for a Plot
Up: AST Routine Descriptions
Previous: AST_MAPSPLIT - Split a Mapping up into parallel component Mappings


AST_MAPTYPE - Get the data type of an entry in a KeyMap

Description:
This function returns a value indicating the data type of a named entry in a KeyMap. This is the data type which was used when the entry was added to the KeyMap.
Invocation:
RESULT = AST_MAPTYPE( THIS, KEY, STATUS )
Arguments:
THIS = INTEGER (Given)
Pointer to the KeyMap.
KEY = CHARACTER $*$ ( $*$ ) (Given)
The character string identifying the KeyMap entry. Trailing spaces are ignored. The supplied string is converted to upper case before use if the KeyCase attribute is currently set to zero.
STATUS = INTEGER (Given and Returned)
The global status.
Returned Value:
AST_MAPTYPE = INTEGER
One of AST__INTTYPE (for integer), AST__SINTTYPE (for INTEGER$*$2), AST__BYTETYPE (for unsigned bytes ) AST__DOUBLETYPE (for double precision floating point), AST__FLOATTYPE (for single precision floating point), AST__STRINGTYPE (for character string), AST__OBJECTTYPE (for AST Object pointer), AST__POINTERTYPE (for arbitrary C pointer) or AST__UNDEFTYPE (for undefined values created by AST_MAPPUTU). AST__BADTYPE is returned if the supplied key is not found in the KeyMap.
Notes:
  • A function value of AST__BADTYPE will be returned if an error has already occurred, or if this function should fail for any reason.


next up previous 264
Next: AST_MARK - Draw a set of markers for a Plot
Up: AST Routine Descriptions
Previous: AST_MAPSPLIT - Split a Mapping up into parallel component Mappings

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2009 Science \& Technology Facilities Council