fmtmsg.h(0p)

1<fmtmsg.h>(0P)             POSIX Programmer's Manual            <fmtmsg.h>(0P)
2
3
4

NAME

6       fmtmsg.h - message display structures
7

SYNOPSIS

9       #include <fmtmsg.h>
10

DESCRIPTION

12       The  <fmtmsg.h>  header shall define the following macros, which expand
13       to constant integer expressions:
14
15       MM_HARD
16              Source of the condition is hardware.
17
18       MM_SOFT
19              Source of the condition is software.
20
21       MM_FIRM
22              Source of the condition is firmware.
23
24       MM_APPL
25              Condition detected by application.
26
27       MM_UTIL
28              Condition detected by utility.
29
30       MM_OPSYS
31              Condition detected by operating system.
32
33       MM_RECOVER
34              Recoverable error.
35
36       MM_NRECOV
37              Non-recoverable error.
38
39       MM_HALT
40              Error causing application to halt.
41
42       MM_ERROR
43              Application has encountered a non-fatal fault.
44
45       MM_WARNING
46              Application has detected unusual non-error condition.
47
48       MM_INFO
49              Informative message.
50
51       MM_NOSEV
52              No severity level provided for the message.
53
54       MM_PRINT
55              Display message on standard error.
56
57       MM_CONSOLE
58              Display message on system console.
59
60
61       The table below indicates the null values and identifiers for  fmtmsg()
62       arguments.   The <fmtmsg.h> header shall define the macros in the Iden‐
63       tifier column, which expand to  constant  expressions  that  expand  to
64       expressions of the type indicated in the Type column:
65
66
67                     Argument   Type     Null-Value   Identifier
68                     label      char *   (char*)0     MM_NULLLBL
69                     severity   int      0            MM_NULLSEV
70                     class      long     0L           MM_NULLMC
71                     text       char *   (char*)0     MM_NULLTXT
72                     action     char *   (char*)0     MM_NULLACT
73                     tag        char *   (char*)0     MM_NULLTAG
74
75       The <fmtmsg.h> header shall also define the following macros for use as
76       return values for fmtmsg():
77
78       MM_OK  The function succeeded.
79
80       MM_NOTOK
81              The function failed completely.
82
83       MM_NOMSG
84              The function was unable to generate a message on standard error,
85              but otherwise succeeded.
86
87       MM_NOCON
88              The  function was unable to generate a console message, but oth‐
89              erwise succeeded.
90
91
92       The following shall be declared as a function and may also  be  defined
93       as a macro. A function prototype shall be provided.
94
95
96              int fmtmsg(long, const char *, int,
97                  const char *, const char *, const char *);
98
99       The following sections are informative.
100

APPLICATION USAGE

102       None.
103

RATIONALE

105       None.
106

FUTURE DIRECTIONS

108       None.
109

COPYRIGHT

114       Portions  of  this text are reprinted and reproduced in electronic form
115       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
116       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
117       Specifications Issue 6, Copyright (C) 2001-2003  by  the  Institute  of
118       Electrical  and  Electronics  Engineers, Inc and The Open Group. In the
119       event of any discrepancy between this version and the original IEEE and
120       The  Open Group Standard, the original IEEE and The Open Group Standard
121       is the referee document. The original Standard can be  obtained  online
122       at http://www.opengroup.org/unix/online.html .
123
124
125
126IEEE/The Open Group                  2003                       <fmtmsg.h>(0P)