2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH FSTYP_STRERROR 3FSTYP "Jun 20, 2006"
8 fstyp_strerror \- get error message string
12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lfstyp\fR \fB -lnvpair \fR [ \fIlibrary\fR\&.\|.\|. ]
13 #include <libnvpair.h>
16 \fBconst char *\fR\fBfstyp_strerror\fR(\fBfstyp_handle_t\fR \fIhandle\fR, \fBint\fR \fIerror\fR);
26 Opaque handle returned by \fBfstyp_init\fR(3FSTYP). This argument is optional
36 Error value returned by a \fBlibfstyp\fR function.
42 The \fBfstyp_strerror()\fR function maps the error value to an error message
43 string and returns a pointer to that string. The returned string should not be
47 The following error values are defined:
51 \fB\fBFSTYP_ERR_NO_MATCH\fR\fR
60 \fB\fBFSTYP_ERR_MULT_MATCH\fR\fR
63 Multiple file system matches.
69 \fB\fBFSTYP_ERR_HANDLE\fR\fR
78 \fB\fBFSTYP_ERR_OFFSET\fR\fR
81 Supplied offset is invalid or unsupported by the module.
87 \fB\fBFSTYP_ERR_NO_PARTITION\fR\fR
90 Specified partition not found.
96 \fB\fBFSTYP_ERR_NOP\fR\fR
105 \fB\fBFSTYP_ERR_DEV_OPEN\fR\fR
108 Device cannot be opened.
114 \fB\fBFSTYP_ERR_IO\fR\fR
123 \fB\fBFSTYP_ERR_NOMEM\fR\fR
132 \fB\fBFSTYP_ERR_MOD_NOT_FOUND\fR\fR
135 Requested file system module not found.
141 \fB\fBFSTYP_ERR_MOD_DIR_OPEN\fR\fR
144 Directory cannot be opened.
150 \fB\fBFSTYP_ERR_MOD_OPEN\fR\fR
153 Module cannot be opened.
159 \fB\fBFSTYP_ERR_MOD_INVALID\fR\fR
162 Invalid module version.
168 \fB\fBFSTYP_ERR_NAME_TOO_LONG\fR\fR
171 File system name length exceeds system limit.
177 See \fBattributes\fR(5) for descriptions of the following attributes:
185 ATTRIBUTE TYPE ATTRIBUTE VALUE
187 Interface Stability Evolving
195 \fBfstyp_init\fR(3FSTYP), \fBlibfstyp\fR(3LIB), \fBattributes\fR(5)