Description:
This
routine writes a standard error report for an error arising within a FITSIO-library routine. The report
comprises two parts. First there is a contextual error report. The error number is translated to an error
string and appended to the supplied message. Thus the contextual message is of the form:
<ROUTIN
>:
<MESSGE
>
Error was: or
<MESSGE
>
Error was: when ROUTIN is a blank string. After this header message, the FITSIO error
stack is flushed. If for some strange reason, there are no error messages in the stack, this
routine appends the short translation of the error number, and if there is no translation, it
reports the FITSIO error number and instruct the reader to consult the FITSIO User
’ s
Guide.
The global status is set to SAI__ERROR. This routine attempts to work even if the global status is bad
on entry.
Invocation
CALL CVG_FIOER( FSTAT, PARAM, ROUTIN, MESSGE, STATUS )
Arguments
FSTAT = INTEGER (Given)
The FITSIO status.
PARAM = CHARACTER
∗ (
∗ ) (Given)
The parameter name of the error report. It usually comprises the name of the routine where the
FITSIO routine is called followed by some suitable suffix like ’ _ERR’ .
ROUTIN = CHARACTER
∗ (
∗
) (Given)
The name of the FITSIO routine where the error occurred. It may be
blank to prevent it appearing in the error report.
MESSGE = CHARACTER
∗ (
∗ )
(Given)
A contextual error message to form part of the error report. It should indicate what was
happening when the call to the FITSIO routine was made. No punctuation is added between this and
the " Error was" text, so a full stop should appear in this message.
STATUS = INTEGER (Given and
Returned)
The global status.
Notes:
The error name for the FITSIO error messages is
FITSIO_ERR.
[optional_subroutine_items]...