next up previous 264
Next: AST_SETFITSU - Store an undefined keyword value in a FitsChan
Up: AST Routine Descriptions
Previous: AST_SETFITSX - Store a keyword value in a FitsChan


AST_SETFITSCM - Store a comment card in a FitsChan

Description:
This routine stores a comment card ( i.e. a card with no keyword name or equals sign) within a FitsChan at the current card position. The new card can either over-write an existing card, or can be inserted as a new card into the FitsChan.
Invocation:
CALL AST_SETFITSCM( THIS, COMMENT, OVERWRITE, STATUS )
Arguments:
THIS = INTEGER (Given)
Pointer to the FitsChan.
COMMENT = CHARACTER $*$ ( $*$ ) (Given)
A string holding the text of the comment card. If a blank string is supplied, then a totally blank card is produced.
OVERWRITE = LOGICAL (Given)
If .TRUE., the new card over-writes the current card, and the current card is incremented to refer to the next card (see the "Card" attribute). If .FALSE., the new card is inserted in front of the current card and the current card is left unchanged. In either case, if the current card on entry points to the "end-of-file", the new card is appended to the end of the list.
STATUS = INTEGER (Given and Returned)
The global status.
Notes:
  • If, on exit, there are no cards following the card written by this function, then the current card is left pointing at the "end-of-file".


next up previous 264
Next: AST_SETFITSU - Store an undefined keyword value in a FitsChan
Up: AST Routine Descriptions
Previous: AST_SETFITSX - Store a keyword value in a FitsChan

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