next up previous 264
Next: LTOffset - The offset from UTC to Local Time, in hours
Up: AST Attribute Descriptions
Previous: KeyCase - Are keys case sensitive?


KeyError - Report an error when getting the value of a non-existant KeyMap entry?

Description:
This attribute is a boolean value which controls how the AST_MAPGET... functions behave if the requested key is not found in the KeyMap. If KeyError is zero (the default), then these functions will return .FALSE. but no error will be reported. If KeyError is non-zero, then the same values are returned but an error is also reported.
Type:
Integer (boolean).
Class Applicability:
KeyMap
All KeyMaps have this attribute.
Notes:
  • When setting a new value for KeyError, the supplied value is propagated to any KeyMaps contained within the supplied KeyMap.

  • When clearing the KeyError attribute, the attribute is also cleared in any KeyMaps contained within the supplied KeyMap.


next up previous 264
Next: LTOffset - The offset from UTC to Local Time, in hours
Up: AST Attribute Descriptions
Previous: KeyCase - Are keys case sensitive?

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