xref: /illumos-gate/usr/src/man/man3fstyp/fstyp_get_attr.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_get_attr 3FSTYP "20 Jun 2006" "SunOS 5.11" "File System Type Identification Library Functions"
 NAME
fstyp_get_attr - get file system attributes

 SYNOPSIS


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

int fstyp_get_attr(fstyp_handle_t handle, nvlist_t **attrp);




 PARAMETERS

handle


Opaque handle returned by fstyp_ident(3FSTYP).





attrp


Address to which the name-pair list is returned.




 DESCRIPTION

The fstyp_get_attr() function returns a name-value pair list of various
attributes for an identified file system. This function can be called only
after a successful call to fstyp_ident().


Each file system has its own set of attributes. The following attributes are
generic and are returned when appropriate for a particular file system type:


gen_clean (DATA_TYPE_BOOLEAN_VALUE)


Attribute for which true and false values are allowed. A
false value is returned if the file system is damaged or if the file
system is not cleanly unmounted. In the latter case, fsck(1M) is required
before the file system can be mounted.





gen_guid (DATA_TYPE_STRING)


Globally unique string identifier used to establish the identity of the file
system.





gen_version (DATA_TYPE_STRING)


String that specifes the file system version.





gen_volume_label (DATA_TYPE_STRING)


Human-readable volume label string used to describe and/or identify the file
system.
Attribute names associated with specific file systems should not start with
gen_.




 RETURN VALUES

The fstyp_get_attr() function returns 0 on success and an error
value on failure. See fstyp_strerror(3FSTYP).

 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe



 SEE ALSO

fstyp_ident(3FSTYP), fstyp_mod_init(3FSTYP),
fstyp_strerror(3FSTYP), libfstyp(3LIB), attributes(5)