next up previous 264
Next: astMapRegion - Transform a Region into a new Frame using a given Mapping
Up: AST Function Descriptions
Previous: astMapPutElemX - Put a value into an element of a vector value in a KeyMap


astMapPutU - Add an entry to a KeyMap with an undefined value

Description:
This function adds a new entry to a KeyMap, but no value is stored with the entry. The entry therefore has a special data type represented by symbolic constant AST__UNDEFTYPE.

An example use is to add entries with undefined values to a KeyMap prior to locking them with the MapLocked attribute. Such entries can act as placeholders for values that can be added to the KeyMap later.

Synopsis:
void astMapPutU( AstKeyMap $*$this, const char $*$key, const char $*$comment );
Parameters:
this
Pointer to the KeyMap in which to store the supplied value.
key
A character string to be stored with the value, which can later be used to identify the value. Trailing spaces are ignored. The supplied string is converted to upper case before use if the KeyCase attribute is currently set to zero.
comment
A pointer to a null-terminated comment string to be stored with the value. A NULL pointer may be supplied, in which case no comment is stored.
Notes:
  • If the supplied key is already in use in the KeyMap, the value associated with the key will be removed.


next up previous 264
Next: astMapRegion - Transform a Region into a new Frame using a given Mapping
Up: AST Function Descriptions
Previous: astMapPutElemX - Put a value into an element of a vector value in a KeyMap

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

Copyright (C) 2009 Science \& Technology Facilities Council