next up previous 207
Next: NDG_REMOVEPROV - Remove one or more ancestors from a provenance structure
Up: Routines for accessing NDF Provenance
Previous: NDG_PUTPROV - Add an NDF to the list of ancestors


NDG_READPROV - Read the provenance information from an NDF

Description:
This function reads the information stored in the "PROVENANCE" extension of an NDF, storing it in a memory-resident structure for faster access. An identifier for this structure is returned, and can be passed to other NDG provenance functions to manipulate the contents of the structure.

If the NDF has no provenance information (for instance, if it is a newly created NDF), the returned structure will contain just the supplied creator name (which may be blank), and an empty ancestor list.

The structure should be freed when it is no longer needed by calling NDG_FREEPROV.

The structure should be freed when it is no longer needed by calling NDG_FREEPROV.


Invocation:
CALL NDG_READPROV( INDF, CREATOR, IPROV, STATUS )

Arguments:

INDF = INTEGER (Given)
An identifier for the NDF containing the provenance information to be read.
CREATOR = CHARACTER $*$ ( $*$ ) (Given)
A text identifier for the software that created INDF (usually the name of the calling application). The format of the identifier is arbitrary, but the form "PACKAGE:COMMAND" is recommended.
IPROV = INTEGER (Returned)
An identifier for the structure holding the provenance information read from the NDF. NDG__NULL is returned if an error occurs.
STATUS = INTEGER (Given and Returned)
The global status.



next up previous 207
Next: NDG_REMOVEPROV - Remove one or more ancestors from a provenance structure
Up: Routines for accessing NDF Provenance
Previous: NDG_PUTPROV - Add an NDF to the list of ancestors

NDG [1ex
Starlink User Note 2
D.S. Berry
M.B. Taylor
22nd October 2009
E-mail:ussc@star.rl.ac.uk

Copyright © 2000 Council for the Central Laboratory of the Research Councils