next up previous
Next: AST_REMAPFRAME - Modify a Frame's relationship to other Frames in a FrameSet
Up: AST Routine Descriptions
Previous: AST_PUTLINE - Store a text line read by a Channel source routine

AST_READ - Read an Object from a Channel   

Description:
This function reads the next Object from a Channel and returns a pointer to the new Object.

Invocation:
RESULT = AST_READ( THIS, STATUS )

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

Returned Value:
AST_READ = INTEGER
A pointer to the new Object. The class to which this will belong is determined by the input data, so is not known in advance.

Notes:
  • A null Object pointer (AST__NULL) will be returned, without error, if the Channel contains no further Objects to be read.
  • A null Object pointer will also 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_REMAPFRAME - Modify a Frame's relationship to other Frames in a FrameSet
Up: AST Routine Descriptions
Previous: AST_PUTLINE - Store a text line read by a Channel source routine

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