xref: /illumos-gate/usr/src/man/man3head/fmtmsg.h.3head (revision b8052df9f609edb713f6828c9eecc3d7be19dfb3)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

FMTMSG.H 3HEAD "Sep 10, 2004"
NAME
fmtmsg.h, fmtmsg - message display structures
SYNOPSIS

#include <fmtmsg.h>
DESCRIPTION

The <fmtmsg.h> header defines the following macros, which expand to constant integer expressions: MM_HARD

Source of the condition is hardware.

MM_SOFT

Source of the condition is software.

MM_FIRM

Source of the condition is firmware.

MM_APPL

Condition detected by application.

MM_UTIL

Condition detected by utility.

MM_OPSYS

Condition detected by operating system.

MM_RECOVER

Recoverable error.

MM_NRECOV

Non-recoverable error.

MM_HALT

Error causing application to halt.

MM_ERROR

Application has encountered a non-fatal fault.

MM_WARNING

Application has detected unusual non-error condition.

MM_INFO

Informative message.

MM_NOSEV

No severity level provided for the message.

MM_PRINT

Display message on standard error.

MM_CONSOLE

Display message on system console.

The table below indicates the null values and identifiers for fmtmsg(3C) arguments. The <fmtmsg.h> header defines the macros in the Identifier column, which expand to constant expressions that expand to expressions of the type indicated in the Type column:

Argument Type Null-Value Identifier
label char* (char*) NULL MM_NULLLBL
severity int 0 MM_NULLSEV
class long 0L MM_NULLMC
text char* (char*) NULL MM_NULLTXT
action char* (char*) NULL MM_NULLACT
tag char* (char*) NULL MM_NULLTAG

The <fmtmsg.h> header also defines the following macros for use as return values for fmtmsg(): MM_OK

The function succeeded.

MM_NOTOK

The function failed completely.

MM_NOMSG

The function was unable to generate a message on standard error, but otherwise succeeded.

MM_NOCON

The function was unable to generate a console message, but otherwise succeeded.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

fmtmsg (3C), attributes (7), standards (7)