next up previous 200
Next: AGI_IBASE - Inquire base picture for current device
Up: Routine Specifications
Previous: AGI_END - Mark the end of an AGI scope


AGI_GTREF - Get a reference object from a picture

Description:
This returns a reference to a data object which has been stored in the database. The picture identifier signifies which picture to obtain the reference from. If this identifier is negative then the current picture is used. If no reference object is found for the given picture an error is returned. If the reference was created from an HDS locator then an HDS locator is returned, and this should be annulled in the application using REF_ANNUL to ensure the file is properly closed.

Invocation:
CALL AGI_GTREF ( PICID, MODE, DATREF, STATUS )

Arguments:

PICID = INTEGER (Given)
Picture identifier
MODE = CHARACTER $*$ ( $*$ ) (Given)
Access mode for object, 'READ', 'WRITE', or 'UPDATE'
DATREF = CHARACTER $*$ ( $*$ ) (Returned)
String containing reference object
STATUS = INTEGER (Given and Returned)
The global status



next up previous 200
Next: AGI_IBASE - Inquire base picture for current device
Up: Routine Specifications
Previous: AGI_END - Mark the end of an AGI scope

AGI --- Applications Graphics Interface Library
Starlink User Note 48
Nicholas Eaton
Brian McIlwrath
30 January 2002
E-mail:ussc@star.rl.ac.uk

Copyright © 2009 Science and Technology Facilities Council