usr/src/man/man3fstyp/fstyp_strerror.3fstyp

   1 '\" te
   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"
   7 .SH NAME
   8 fstyp_strerror \- get error message string
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lfstyp\fR \fB -lnvpair \fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <libnvpair.h>
  14 #include <libfstyp.h>
  15
  16 \fBconst char *\fR\fBfstyp_strerror\fR(\fBfstyp_handle_t\fR \fIhandle\fR, \fBint\fR \fIerror\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIhandle\fR\fR
  24 .ad
  25 .RS 10n
  26 Opaque handle returned by \fBfstyp_init\fR(3FSTYP). This argument is optional
  27 and can be \fB0\fR.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIerror\fR\fR
  34 .ad
  35 .RS 10n
  36 Error value returned by a \fBlibfstyp\fR function.
  37 .RE
  38
  39 .SH DESCRIPTION
  40 .sp
  41 .LP
  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
  44 overwritten.
  45 .sp
  46 .LP
  47 The following error values are defined:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBFSTYP_ERR_NO_MATCH\fR\fR
  52 .ad
  53 .RS 27n
  54 No file system match.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBFSTYP_ERR_MULT_MATCH\fR\fR
  61 .ad
  62 .RS 27n
  63 Multiple file system matches.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBFSTYP_ERR_HANDLE\fR\fR
  70 .ad
  71 .RS 27n
  72 Invalid handle.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBFSTYP_ERR_OFFSET\fR\fR
  79 .ad
  80 .RS 27n
  81 Supplied offset is invalid or unsupported by the module.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBFSTYP_ERR_NO_PARTITION\fR\fR
  88 .ad
  89 .RS 27n
  90 Specified partition not found.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBFSTYP_ERR_NOP\fR\fR
  97 .ad
  98 .RS 27n
  99 No such operation.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBFSTYP_ERR_DEV_OPEN\fR\fR
 106 .ad
 107 .RS 27n
 108 Device cannot be opened.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBFSTYP_ERR_IO\fR\fR
 115 .ad
 116 .RS 27n
 117 I/O error.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBFSTYP_ERR_NOMEM\fR\fR
 124 .ad
 125 .RS 27n
 126 Out of memory.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBFSTYP_ERR_MOD_NOT_FOUND\fR\fR
 133 .ad
 134 .RS 27n
 135 Requested file system module not found.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBFSTYP_ERR_MOD_DIR_OPEN\fR\fR
 142 .ad
 143 .RS 27n
 144 Directory cannot be opened.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBFSTYP_ERR_MOD_OPEN\fR\fR
 151 .ad
 152 .RS 27n
 153 Module cannot be opened.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBFSTYP_ERR_MOD_INVALID\fR\fR
 160 .ad
 161 .RS 27n
 162 Invalid module version.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBFSTYP_ERR_NAME_TOO_LONG\fR\fR
 169 .ad
 170 .RS 27n
 171 File system name length exceeds system limit.
 172 .RE
 173
 174 .SH ATTRIBUTES
 175 .sp
 176 .LP
 177 See \fBattributes\fR(5) for descriptions of the following attributes:
 178 .sp
 179
 180 .sp
 181 .TS
 182 box;
 183 c | c
 184 l | l .
 185 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 186 _
 187 Interface Stability     Evolving
 188 _
 189 MT-Level        MT-Safe
 190 .TE
 191
 192 .SH SEE ALSO
 193 .sp
 194 .LP
 195 \fBfstyp_init\fR(3FSTYP), \fBlibfstyp\fR(3LIB), \fBattributes\fR(5)