Next: NDF_HECHO - Write out lines of history text
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_HCRE - Ensure that a history component exists for an NDF
NDF_HDEF
- Write default history information to an NDF
- Description:
- The routine writes default information about the current
application to the history component of an NDF, creating a new
history record if necessary.
- Invocation:
- CALL NDF_HDEF( INDF, APPN, STATUS )
- Arguments:
-
-
INDF = INTEGER (Given)
-
NDF identifier.
-
APPN = CHARACTER
(
) (Given)
-
Name of the current application. This will only be used if a
new history record is created by this routine, otherwise it is
ignored. If a blank value is given, then a suitable default
will be used instead.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
- The values stored in the history component for any program
parameters that have not yet been accessed by the program at the
time this routine is called may not be correct. The value left
by the previous invocation of the program will be used, if it is
stored in the program's parameter file. If there is no value for
the parameter in the parameter file, a value of "<not yet
accessed>" will be stored for the parameter in the history
component. For this reason, this routine should usually be
called once all program parameters have been accessed.
- Default history information will normally be provided
automatically by the NDF_ system when an NDF is released, so a
call to this routine is not usually required. It is provided so
that premature writing of default history information can be
forced in cases where additional text will then be appended to it
(using NDF_HPUT).
- It is expected that the APPN argument will usually be left
blank. A non-blank value should normally only be given if a more
complete identification of the current application can be given
than is supplied by default.
- This routine will return without action if (a) there is no
history component present in the NDF, (b) the NDF's history
update mode is currently 'DISABLED', (c) default history
information has already been written to the NDF, or (d) a
previous call has been made to NDF_HPUT specifying that default
history information is to be replaced.
Next: NDF_HECHO - Write out lines of history text
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_HCRE - Ensure that a history component exists for an NDF
NDF [1ex
Starlink User Note 33
R.F. Warren-Smith & D.S. Berry
16th July 2012
E-mail:starlink@jiscmail.ac.uk
Copyright © 2013 Science and Technology Facilities Council