ndgWriteProv - Write provenance information to an NDF

Description:

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

Invocation:

void ndgWriteProv( NdgProvenance $*$prov, int indf, int whdef, int $*$status )

Arguments:

prov

A pointer to the provenance information to be written out.

indf

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

whdef

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 ndfAnnul or ndfEnd). 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 a non-zero value, a check is made to see if default history has already been stored in the NDF. If not, 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 a zero value for "whdef" and should also ensure that history information has been stored in the NDF before calling this function.

status

The global status.