xref: /netbsd-src/include/fmtmsg.h (revision 5e4c038a45edbc7d63b7c2daa76e29f88b64a4e3)
1 /*	$NetBSD: fmtmsg.h,v 1.1 1999/09/12 19:04:30 kleink Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Klaus Klein.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #ifndef _FMTMSG_H_
40 #define _FMTMSG_H_
41 
42 /* Major Classifications: identifies the source of the condition. */
43 #define MM_HARD		0x01L	/* Hardware */
44 #define MM_SOFT		0x02L	/* Software */
45 #define MM_FIRM		0x03L	/* Firmware */
46 
47 /* Message Source Subclassifications: type of software. */
48 #define MM_APPL		0x04L	/* Application */
49 #define MM_UTIL		0x08L	/* Utility */
50 #define MM_OPSYS	0x0cL	/* Operating system */
51 
52 /* Display Subclassifications: where to display the message. */
53 #define MM_PRINT	0x10L	/* Display on standard error */
54 #define MM_CONSOLE	0x20L	/* Display on system console */
55 
56 /* Status subclassifications: whether the application will recover. */
57 #define MM_RECOVER	0x40L	/* Recoverable */
58 #define MM_NRECOV	0x80L	/* Non-recoverable */
59 
60 /* Severity: seriousness of the condition. */
61 #define MM_NOSEV	0	/* No severity level provided */
62 #define MM_HALT		1	/* Error causing application to halt */
63 #define MM_ERROR	2	/* Encountered a non-fatal fault */
64 #define MM_WARNING	3	/* Unusual non-error condition */
65 #define MM_INFO		4	/* Informative message */
66 
67 /* `Null' values for message components. */
68 #define MM_NULLMC	0L		/* `Null' classsification component */
69 #define MM_NULLLBL	(char *)0	/* `Null' label component */
70 #define MM_NULLSEV	0		/* `Null' severity component */
71 #define MM_NULLTXT	(char *)0	/* `Null' text component */
72 #define MM_NULLACT	(char *)0	/* `Null' action component */
73 #define MM_NULLTAG	(char *)0	/* `Null' tag component */
74 
75 /* Return values for fmtmsg(). */
76 #define MM_OK		0	/* Function succeeded */
77 #define MM_NOTOK	(-1)	/* Function failed completely */
78 #define MM_NOMSG	0x01	/* Unable to perform MM_PRINT */
79 #define MM_NOCON	0x02	/* Unable to perform MM_CONSOLE */
80 
81 #include <sys/cdefs.h>
82 
83 __BEGIN_DECLS
84 int	fmtmsg __P((long, const char *, int, const char *, const char *,
85 	    const char *));
86 __END_DECLS
87 
88 #endif /* !_FMTMSG_H_ */
89