NDG_WRITEPROV - Write provenance information to an NDF

Description:

This routine writes the contents of the supplied provenance structure out to a given NDF, replacing any existing provenance information in the NDF.

Invocation:

CALL NDG_WRITEPROV( IPROV, INDF, WHDEF, STATUS )

Arguments:

IPROV = INTEGER (Given)

An identifier for a structure holding the provenance information read from an NDF, as returned by NDG_READPROV.

INDF = INTEGER (Given)

Identifier for the NDF in which to store the provenance information.

WHDEF = INTEGER (Given)

The correct recording of history information within the PROVENANCE extension requires that the current history record within the supplied NDF at the time this function is called, describes the creation of the NDF. Very often, an application will not itself add any history to the NDF, but will instead rely on the automatic recording of default history provided by the NDF library. Normally, default history is recorded when the NDF is released from the NDF system (e.g. using NDF_ANNUL or NDF_END). So if this function is called prior to the release of the NDF (which it normally will be), then the default history information will not yet have been recorded, resulting in incorrect information being stored in the PROVENANCE extension. For this reason, the WHDEF argument is supplied. If it is set to .TRUE., a check is made to see if default history has already been stored in the NDF. If .FALSE., default history is stored in the NDF before going on to create the PROVENANCE extension. Applications that do not use the default history recording mechanism, but instead store their own history information, should supply .FALSE. for WHDEF, and should also ensure that history information has been stored in the NDF before calling this routine.

STATUS = INTEGER (Given and Returned)

The global status.