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

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