usr/src/man/man3head/fmtmsg.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH FMTMSG.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 fmtmsg.h, fmtmsg \- message display structures
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBfmtmsg.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBfmtmsg.h\fR> header defines the following macros, which expand to
  23 constant integer expressions:
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fBMM_HARD\fR\fR
  28 .ad
  29 .RS 14n
  30 Source of the condition is hardware.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBMM_SOFT\fR\fR
  37 .ad
  38 .RS 14n
  39 Source of the condition is software.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBMM_FIRM\fR\fR
  46 .ad
  47 .RS 14n
  48 Source of the condition is firmware.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBMM_APPL\fR\fR
  55 .ad
  56 .RS 14n
  57 Condition detected by application.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBMM_UTIL\fR\fR
  64 .ad
  65 .RS 14n
  66 Condition detected by utility.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBMM_OPSYS\fR\fR
  73 .ad
  74 .RS 14n
  75 Condition detected by operating system.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBMM_RECOVER\fR\fR
  82 .ad
  83 .RS 14n
  84 Recoverable error.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBMM_NRECOV\fR\fR
  91 .ad
  92 .RS 14n
  93 Non-recoverable error.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBMM_HALT\fR\fR
 100 .ad
 101 .RS 14n
 102 Error causing application to halt.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBMM_ERROR\fR\fR
 109 .ad
 110 .RS 14n
 111 Application has encountered a non-fatal fault.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBMM_WARNING\fR\fR
 118 .ad
 119 .RS 14n
 120 Application has detected unusual non-error condition.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBMM_INFO\fR\fR
 127 .ad
 128 .RS 14n
 129 Informative message.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBMM_NOSEV\fR\fR
 136 .ad
 137 .RS 14n
 138 No severity level provided for the message.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBMM_PRINT\fR\fR
 145 .ad
 146 .RS 14n
 147 Display message on standard error.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBMM_CONSOLE\fR\fR
 154 .ad
 155 .RS 14n
 156 Display message on system console.
 157 .RE
 158
 159 .sp
 160 .LP
 161 The table below indicates the null values and identifiers for \fBfmtmsg\fR(3C)
 162 arguments. The <\fBfmtmsg.h\fR> header defines the macros in the Identifier
 163 column, which expand to constant expressions that expand to expressions of the
 164 type indicated in the Type column:
 165 .sp
 166
 167 .sp
 168 .TS
 169 l l l l
 170 l l l l .
 171 Argument        Type    Null-Value      Identifier
 172 \fIlabel\fR     \fBchar*\fR     \fB(char*) NULL\fR      \fBMM_NULLLBL\fR
 173 \fIseverity\fR  \fBint\fR       \fB0\fR \fBMM_NULLSEV\fR
 174 \fIclass\fR     \fBlong\fR      \fB0L\fR        \fBMM_NULLMC\fR
 175 \fItext\fR      \fBchar*\fR     \fB(char*) NULL\fR      \fBMM_NULLTXT\fR
 176 \fIaction\fR    \fBchar*\fR     \fB(char*) NULL\fR      \fBMM_NULLACT\fR
 177 \fItag\fR       \fBchar*\fR     \fB(char*) NULL\fR      \fBMM_NULLTAG\fR
 178 .TE
 179
 180 .sp
 181 .LP
 182 The <\fBfmtmsg.h\fR> header also defines the following macros for use as return
 183 values for \fBfmtmsg()\fR:
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fBMM_OK\fR\fR
 188 .ad
 189 .RS 12n
 190 The function succeeded.
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fBMM_NOTOK\fR\fR
 197 .ad
 198 .RS 12n
 199 The function failed completely.
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fBMM_NOMSG\fR\fR
 206 .ad
 207 .RS 12n
 208 The function was unable to generate a message on standard error, but otherwise
 209 succeeded.
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB\fBMM_NOCON\fR\fR
 216 .ad
 217 .RS 12n
 218 The function was unable to generate a console message, but otherwise succeeded.
 219 .RE
 220
 221 .SH ATTRIBUTES
 222 .sp
 223 .LP
 224 See \fBattributes\fR(5) for descriptions of the following attributes:
 225 .sp
 226
 227 .sp
 228 .TS
 229 box;
 230 c | c
 231 l | l .
 232 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 233 _
 234 Interface Stability     Standard
 235 .TE
 236
 237 .SH SEE ALSO
 238 .sp
 239 .LP
 240 \fBfmtmsg\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)