Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

fstyp_get_attr(3FSTYP)

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(8) 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 specifies 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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe

See Also

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