usr/src/man/man3fstyp/fstyp_get_attr.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_GET_ATTR 3FSTYP "Jun 20, 2006"
   7 .SH NAME
   8 fstyp_get_attr \- get 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_get_attr\fR(\fBfstyp_handle_t\fR \fIhandle\fR, \fBnvlist_t **\fR\fIattrp\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_ident\fR(3FSTYP).
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIattrp\fR\fR
  33 .ad
  34 .RS 10n
  35 Address to which the name-pair list is returned.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBfstyp_get_attr()\fR function returns a name-value pair list of various
  42 attributes for an identified file system. This function can be called only
  43 after a successful call to \fBfstyp_ident()\fR.
  44 .sp
  45 .LP
  46 Each file system has its own set of attributes. The following attributes are
  47 generic and are returned when appropriate for a particular file system type:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBgen_clean (DATA_TYPE_BOOLEAN_VALUE)\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 Attribute for which \fBtrue\fR and \fBfalse\fR values are allowed. A
  56 \fBfalse\fR value is returned if the file system is damaged or if the file
  57 system is not cleanly unmounted. In the latter case, \fBfsck\fR(1M) is required
  58 before the file system can be mounted.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBgen_guid (DATA_TYPE_STRING)\fR\fR
  65 .ad
  66 .sp .6
  67 .RS 4n
  68 Globally unique string identifier used to establish the identity of the file
  69 system.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBgen_version (DATA_TYPE_STRING)\fR\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 String that specifes the file system version.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBgen_volume_label (DATA_TYPE_STRING)\fR\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 Human-readable volume label string used to describe and/or identify the file
  90 system.
  91 .sp
  92 Attribute names associated with specific file systems should not start with
  93 \fBgen_\fR.
  94 .RE
  95
  96 .SH RETURN VALUES
  97 .sp
  98 .LP
  99 The \fBfstyp_get_attr()\fR function returns \fB0\fR on success and an error
 100 value on failure. See \fBfstyp_strerror\fR(3FSTYP).
 101 .SH ATTRIBUTES
 102 .sp
 103 .LP
 104 See \fBattributes\fR(5) for descriptions of the following attributes:
 105 .sp
 106
 107 .sp
 108 .TS
 109 box;
 110 c | c
 111 l | l .
 112 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 113 _
 114 Interface Stability     Evolving
 115 _
 116 MT-Level        MT-Safe
 117 .TE
 118
 119 .SH SEE ALSO
 120 .sp
 121 .LP
 122 \fBfstyp_ident\fR(3FSTYP), \fBfstyp_mod_init\fR(3FSTYP),
 123 \fBfstyp_strerror\fR(3FSTYP), \fBlibfstyp\fR(3LIB), \fBattributes\fR(5)