diff options
Diffstat (limited to 'sys/imfort/doc/imemsg.hlp')
| -rw-r--r-- | sys/imfort/doc/imemsg.hlp | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/sys/imfort/doc/imemsg.hlp b/sys/imfort/doc/imemsg.hlp new file mode 100644 index 00000000..32b1677c --- /dev/null +++ b/sys/imfort/doc/imemsg.hlp @@ -0,0 +1,31 @@ +.help imemsg Sep86 imfort +.ih +NAME +imemsg -- convert an IMFORT error code into an error message +.ih +SYNOPSIS +.nf +subroutine imemsg (ier, errmsg) + +integer ier #I an IMFORT error code +character*(*) errmsg #O the corresponding error message +.fi +.ih +DESCRIPTION +The \fIimemsg\fR procedure converts a positive integer error code, +such as is returned by the IMFORT procedures in the event of an error, +into the corresponding error message string. In cases where the error +was associated with a named object, e.g., a file or image, the operand +name will be enclosed in parenthesis and appended to the base error +message string returned to the user. +.ih +RETURN VALUE +The error message string, or "imfort error (unrecognized error code)" if +called with an unknown error code. +.ih +SEE ALSO +.nf +The individual manual pages for the symbolic names of the error codes +imfort$imfort.h and lib$syserr.h for the integer error codes. +.fi +.endhelp |