usr/src/man/man3fstyp/fstyp_ident.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_IDENT 3FSTYP "Jun 20, 2006"
   7 .SH NAME
   8 fstyp_ident \- identify file system attributes
   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 \fBint\fR \fBfstyp_ident\fR(\fBfstyp_handle_t\fR \fIhandle\fR, \fBconst char *\fR\fIfstyp\fR,
  17      \fBconst char **\fR\fIident\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIhandle\fR\fR
  25 .ad
  26 .RS 10n
  27 Opaque handle returned by \fBfstyp_init\fR(3FSTYP).
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIfstype\fR\fR
  34 .ad
  35 .RS 10n
  36 Opaque argument that specifies the file system type to be identified.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIident\fR\fR
  43 .ad
  44 .RS 10n
  45 File system type returned if identification succeeds.
  46 .RE
  47
  48 .SH DESCRIPTION
  49 .sp
  50 .LP
  51 The \fBfstyp_ident()\fR function attempts to identify a file system associated
  52 with the \fIhandle\fR. If the function succeeds, the file system name is
  53 returned in the \fIident\fR pointer.
  54 .sp
  55 .LP
  56 If \fIfstype\fR is \fINULL\fR, the \fBfstyp_ident()\fR function tries all
  57 available identification modules. If \fIfstype\fR is other than \fINULL\fR,
  58 \fBfstyp_ident()\fR tries only the module for the file system type which is
  59 specified.
  60 .SH RETURN VALUES
  61 .sp
  62 .LP
  63 The \fBfstyp_ident()\fR function returns \fB0\fR on success and an error value
  64 on failure. See \fBfstyp_strerror\fR(3FSTYP).
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Evolving
  79 _
  80 MT-Level        MT-Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBfstyp_init\fR(3FSTYP), \fBfstyp_mod_init\fR(3FSTYP),
  87 \fBfstyp_strerror\fR(3FSTYP), \fBlibfstyp\fR(3LIB), \fBattributes\fR(5)