Current File : //usr/share/man/man3fstyp/fstyp_ident.3fstyp

'\" te
.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
.TH fstyp_ident 3FSTYP "20 Jun 2006" "SunOS 5.11" "File System Type Identification Library Functions"
.SH NAME
fstyp_ident \- identify file system attributes
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lfstyp\fR \fB -lnvpair \fR [ \fIlibrary\fR\&.\|.\|. ]
#include <libnvpair.h>
#include <libfstyp.h>

\fBint\fR \fBfstyp_ident\fR(\fBfstyp_handle_t\fR \fIhandle\fR, \fBconst char *\fR\fIfstyp\fR,
     \fBconst char **\fR\fIident\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIhandle\fR\fR
.ad
.RS 10n
.rt  
Opaque handle returned by \fBfstyp_init\fR(3FSTYP).
.RE

.sp
.ne 2
.mk
.na
\fB\fIfstype\fR\fR
.ad
.RS 10n
.rt  
Opaque argument that specifies the file system type to be identified.
.RE

.sp
.ne 2
.mk
.na
\fB\fIident\fR\fR
.ad
.RS 10n
.rt  
File system type returned if identification succeeds.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBfstyp_ident()\fR function attempts to identify a file system associated with the \fIhandle\fR. If the function succeeds, the file system name is returned in the \fIident\fR pointer.
.sp
.LP
If \fIfstype\fR is \fINULL\fR, the \fBfstyp_ident()\fR function tries all available identification modules. If \fIfstype\fR is other than \fINULL\fR, \fBfstyp_ident()\fR tries only the module for the file system type which is specified.
.SH RETURN VALUES
.sp
.LP
The \fBfstyp_ident()\fR function returns \fB0\fR on success and an error value on failure. See \fBfstyp_strerror\fR(3FSTYP).
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBfstyp_init\fR(3FSTYP), \fBfstyp_mod_init\fR(3FSTYP), \fBfstyp_strerror\fR(3FSTYP), \fBlibfstyp\fR(3LIB), \fBattributes\fR(5)