xref: /titanic_52/usr/src/man/man3fstyp/fstyp_init.3fstyp (revision 6a1af1a67532df169a657cce07140be64bdea084)
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_init 3FSTYP "20 Jun 2006" "SunOS 5.11" "File System Type Identification Library Functions"
NAME
fstyp_init, fstyp_fini - initialize and finalize libfstyp handle
SYNOPSIS

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

int fstyp_init(int fd, off64_t **offset, char *module_dir,
 fstyp_handle_t *handle);

void fstyp_fini(void *handle);
PARAMETERS

fd

Open file descriptor of a block or a raw device that contains the file system to be identified.

offset

Offset from the beginning of the device where the file system is located.

module_dir

Optional location of the libfstyp modules.

handle

Opaque handle to be used with libfstyp functions.

DESCRIPTION

The fstyp_init() function returns a handle associated with the specified parameters. This handle should be used with all other libfstyp functions.

If module_dir is NULL, fstyp_init() looks for modules in the default location: /usr/lib/fs subdirectories. The fstyp_init() function locates libfstyp modules, but might defer loading the modules until the subsequent fstyp_ident() call.

If module_dir is other than NULL, the fstyp_init() function locates a module in the directory that is specified. If no module is found, fstyp_init fails with FSTYP_ERR_MOD_NOT_FOUND.

Modules that do not support non-zero offset can fail fstyp_init() with FSTYP_ERR_OFFSET.

The fstyp_fini() function releases all resources associated with a handle and invalidates the handle.

RETURN VALUES

The fstyp_init() 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)