next up previous 264
Next: AST_MAPPUT0X - Add a scalar value to a KeyMap
Up: AST Routine Descriptions
Previous: AST_MAPLENC - Get the number of characters in a character entry in a KeyMap


AST_MAPLENGTH - Get the vector length of an entry in a KeyMap

Description:
This function returns the vector length of a named entry in a KeyMap, (that is, how many values are associated with the entry).
Invocation:
RESULT = AST_MAPLENGTH( 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_MAPLENGTH = INTEGER
The length of the entry. One for a scalar, greater than one for a vector. A value of zero is returned if the KeyMap does not contain the named entry.
Notes:
  • A function value of zero will be returned if an error has already occurred, or if this function should fail for any reason.


next up previous 264
Next: AST_MAPPUT0X - Add a scalar value to a KeyMap
Up: AST Routine Descriptions
Previous: AST_MAPLENC - Get the number of characters in a character entry in a KeyMap

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