xref: /onnv-gate/usr/src/cmd/lvm/metassist/common/volume_error.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _VOLUME_ERROR_H
28*0Sstevel@tonic-gate #define	_VOLUME_ERROR_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef __cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * Retrieve the error string for the given error code.
38*0Sstevel@tonic-gate  *
39*0Sstevel@tonic-gate  * @param       error
40*0Sstevel@tonic-gate  *              If error is less than zero, it is assumed to be a
41*0Sstevel@tonic-gate  *              custom error code.  If error is greater than zero, it
42*0Sstevel@tonic-gate  *              is assumed to be an error defined in errno.h.
43*0Sstevel@tonic-gate  *
44*0Sstevel@tonic-gate  * @return      the error string set by volume_set_error()
45*0Sstevel@tonic-gate  *              if error < 0
46*0Sstevel@tonic-gate  *
47*0Sstevel@tonic-gate  * @return      the error string returned by strerror()
48*0Sstevel@tonic-gate  *              if error > 0
49*0Sstevel@tonic-gate  */
50*0Sstevel@tonic-gate extern char *get_error_string(int error);
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate  * Set the error string for the most recent error.  This message can
54*0Sstevel@tonic-gate  * be retrieved with get_error_string(error), assuming error is less
55*0Sstevel@tonic-gate  * than zero.
56*0Sstevel@tonic-gate  *
57*0Sstevel@tonic-gate  * @param       fmt
58*0Sstevel@tonic-gate  *              printf format string
59*0Sstevel@tonic-gate  *
60*0Sstevel@tonic-gate  * @return      the number of characters formatted
61*0Sstevel@tonic-gate  *              if successful
62*0Sstevel@tonic-gate  *
63*0Sstevel@tonic-gate  * @return      negative value
64*0Sstevel@tonic-gate  *              if an error occurred
65*0Sstevel@tonic-gate  */
66*0Sstevel@tonic-gate extern int volume_set_error(char *fmt, ...);
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate #ifdef __cplusplus
69*0Sstevel@tonic-gate }
70*0Sstevel@tonic-gate #endif
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate #endif /* _VOLUME_ERROR_H */
73