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