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"
8 fstyp_get_attr \- get file system attributes
12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lfstyp\fR \fB -lnvpair \fR [ \fIlibrary\fR\&.\|.\|. ]
13 #include <libnvpair.h>
16 \fBint\fR \fBfstyp_get_attr\fR(\fBfstyp_handle_t\fR \fIhandle\fR, \fBnvlist_t **\fR\fIattrp\fR);
26 Opaque handle returned by \fBfstyp_ident\fR(3FSTYP).
35 Address to which the name-pair list is returned.
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.
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:
51 \fB\fBgen_clean (DATA_TYPE_BOOLEAN_VALUE)\fR\fR
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(8) is required
58 before the file system can be mounted.
64 \fB\fBgen_guid (DATA_TYPE_STRING)\fR\fR
68 Globally unique string identifier used to establish the identity of the file
75 \fB\fBgen_version (DATA_TYPE_STRING)\fR\fR
79 String that specifes the file system version.
85 \fB\fBgen_volume_label (DATA_TYPE_STRING)\fR\fR
89 Human-readable volume label string used to describe and/or identify the file
92 Attribute names associated with specific file systems should not start with
99 The \fBfstyp_get_attr()\fR function returns \fB0\fR on success and an error
100 value on failure. See \fBfstyp_strerror\fR(3FSTYP).
104 See \fBattributes\fR(5) for descriptions of the following attributes:
112 ATTRIBUTE TYPE ATTRIBUTE VALUE
114 Interface Stability Evolving
122 \fBfstyp_ident\fR(3FSTYP), \fBfstyp_mod_init\fR(3FSTYP),
123 \fBfstyp_strerror\fR(3FSTYP), \fBlibfstyp\fR(3LIB), \fBattributes\fR(5)