next up previous 264
Next: AST_MAPKEY - Get the key at a given index within the KeyMap
Up: AST Routine Descriptions
Previous: AST_MAPGETELEMX - Get a single element of a vector value from a KeyMap


AST_MAPHASKEY - Check if an entry with a given key exists in a KeyMap

Description:
This function returns a flag indicating if the KeyMap contains an entry with the given key.
Invocation:
RESULT = AST_MAPHASKEY( 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_MAPHASKEY = LOGICAL
.TRUE. if the key was found, and .FALSE. otherwise.
Notes:
  • .TRUE. is returned if the key exists but has an undefined value (that is, the returned value does not depend on whether the entry has a defined value or not).

  • A function value of .FALSE. will be returned if an error has already occurred, or if this function should fail for any reason.


next up previous 264
Next: AST_MAPKEY - Get the key at a given index within the KeyMap
Up: AST Routine Descriptions
Previous: AST_MAPGETELEMX - Get a single element of a vector value from 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