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

PROLOG

6       This  manual  page is part of the POSIX Programmer's Manual.  The Linux
7       implementation of this interface may differ (consult the  corresponding
8       Linux  manual page for details of Linux behavior), or the interface may
9       not be implemented on Linux.
10
11

NAME

13       fmtmsg.h — message display structures
14

SYNOPSIS

16       #include <fmtmsg.h>
17

DESCRIPTION

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

APPLICATION USAGE

88       None.
89

RATIONALE

91       None.
92

FUTURE DIRECTIONS

94       None.
95

SEE ALSO

97       The System Interfaces volume of POSIX.1‐2008, fmtmsg()
98

100       Portions  of  this text are reprinted and reproduced in electronic form
101       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
102       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
103       Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
104       cal  and  Electronics  Engineers,  Inc  and  The  Open Group.  (This is
105       POSIX.1-2008 with the 2013 Technical Corrigendum  1  applied.)  In  the
106       event of any discrepancy between this version and the original IEEE and
107       The Open Group Standard, the original IEEE and The Open Group  Standard
108       is  the  referee document. The original Standard can be obtained online
109       at http://www.unix.org/online.html .
110
111       Any typographical or formatting errors that appear  in  this  page  are
112       most likely to have been introduced during the conversion of the source
113       files to man page format. To report such errors,  see  https://www.ker‐
114       nel.org/doc/man-pages/reporting_bugs.html .
115
116
117
118IEEE/The Open Group                  2013                         fmtmsg.h(0P)
Impressum