aboutsummaryrefslogtreecommitdiff
path: root/sys/imfort/doc/imemsg.hlp
blob: 32b1677c80a649b802f96271c3d436b75fddd872 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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