next up previous
Next: AST_GETFRAME - Obtain a pointer to a specified Frame in a FrameSet
Up: AST Routine Descriptions
Previous: AST_GET<X> - Get an attribute value for an Object

   
AST_GETACTIVEUNIT - Determines how the Unit attribute will be used

Description:
This routine returns the current value of the ActiveUnit flag for a Frame. See the description of the AST_SETACTIVEUNIT routine for a description of the ActiveUnit flag.

Invocation:
RESULT = AST_GETACTIVEUNIT( THIS, STATUS )

Arguments:
THIS = INTEGER (Given)
Pointer to the Frame.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value:
AST_GETACTIVEUNIT = LOGICAL
The current value of the ActiveUnit flag.

Notes:
  • A value of .FALSE. 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_GETFRAME - Obtain a pointer to a specified Frame in a FrameSet
Up: AST Routine Descriptions
Previous: AST_GET<X> - Get an attribute value for an Object

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