xref: /illumos-gate/usr/src/man/man3fstyp/fstyp_strerror.3fstyp (revision afab0816ecb604f0099a09ad8ee398f0d7b77b1c) 
 te
 Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
 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.
 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.
 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]
 fstyp_strerror 3FSTYP "20 Jun 2006" "SunOS 5.11" "File System Type Identification Library Functions"
 NAME
fstyp_strerror - get error message string

 SYNOPSIS


cc [ flag.\|.\|. ] file.\|.\|. -lfstyp  -lnvpair  [ library.\|.\|. ]
#include <libnvpair.h>
#include <libfstyp.h>

const char *fstyp_strerror(fstyp_handle_t handle, int error);




 PARAMETERS

handle


Opaque handle returned by fstyp_init(3FSTYP). This argument is optional
and can be 0.





error


Error value returned by a libfstyp function.




 DESCRIPTION

The fstyp_strerror() function maps the error value to an error message
string and returns a pointer to that string. The returned string should not be
overwritten.


The following error values are defined:


FSTYP_ERR_NO_MATCH


No file system match.





FSTYP_ERR_MULT_MATCH


Multiple file system matches.





FSTYP_ERR_HANDLE


Invalid handle.





FSTYP_ERR_OFFSET


Supplied offset is invalid or unsupported by the module.





FSTYP_ERR_NO_PARTITION


Specified partition not found.





FSTYP_ERR_NOP


No such operation.





FSTYP_ERR_DEV_OPEN


Device cannot be opened.





FSTYP_ERR_IO


I/O error.





FSTYP_ERR_NOMEM


Out of memory.





FSTYP_ERR_MOD_NOT_FOUND


Requested file system module not found.





FSTYP_ERR_MOD_DIR_OPEN


Directory cannot be opened.





FSTYP_ERR_MOD_OPEN


Module cannot be opened.





FSTYP_ERR_MOD_INVALID


Invalid module version.





FSTYP_ERR_NAME_TOO_LONG


File system name length exceeds system limit.




 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe



 SEE ALSO

fstyp_init(3FSTYP), libfstyp(3LIB), attributes(5)