next up previous 264
Next: AST_SAME - Test if two AST pointers refer to the same Object
Up: AST Routine Descriptions
Previous: AST_RESOLVE - Resolve a vector into two orthogonal components


AST_RETAINFITS - Indicate that the current card in a FitsChan should be retained

Description:
This routine stores a flag with the current card in the FitsChan indicating that the card should not be removed from the FitsChan when an Object is read from the FitsChan using AST_READ.

Cards that have not been flagged in this way are removed when a read operation completes succesfully, but only if the card was used in the process of creating the returned AST Object. Any cards that are irrelevant to the creation of the AST Object are retained whether or not they are flagged.

Invocation:
CALL AST_RETAINFITS( THIS, STATUS )
Arguments:
THIS = INTEGER (Given)
Pointer to the FitsChan.
STATUS = INTEGER (Given and Returned)
The global status.
Notes:
  • This function returns without action if the FitsChan is initially positioned at the "end-of-file" (i.e. if the Card attribute exceeds the number of cards in the FitsChan).

  • The current card is not changed by this function.


next up previous 264
Next: AST_SAME - Test if two AST pointers refer to the same Object
Up: AST Routine Descriptions
Previous: AST_RESOLVE - Resolve a vector into two orthogonal components

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