next up previous
Next: AST_GETLINE - Obtain text to be written by a Channel sink routine
Up: AST Routine Descriptions
Previous: AST_GETACTIVEUNIT - Determines how the Unit attribute will be used

   
AST_GETFRAME - Obtain a pointer to a specified Frame in a FrameSet

Description:
This function returns a pointer to a specified Frame in a FrameSet.

Invocation:
RESULT = AST_GETFRAME( THIS, IFRAME, STATUS )

Arguments:
THIS = INTEGER (Given)
Pointer to the FrameSet.
IFRAME = INTEGER (Given)
The index of the required Frame within the FrameSet. This value should lie in the range from 1 to the number of Frames in the FrameSet (as given by its Nframe attribute).
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value:
AST_GETFRAME = INTEGER
A pointer to the requested Frame.

Notes:
  • A value of AST__BASE or AST__CURRENT may be given for the IFRAME argument to specify the base Frame or the current Frame respectively.
  • This function increments the RefCount attribute of the selected Frame by one.
  • A null Object pointer (AST__NULL) will be returned if this function is invoked with STATUS set to an error value, or if it should fail for any reason.



next up previous
Next: AST_GETLINE - Obtain text to be written by a Channel sink routine
Up: AST Routine Descriptions
Previous: AST_GETACTIVEUNIT - Determines how the Unit attribute will be used

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

Copyright (C) 2003 Central Laboratory of the Research Councils