xref: /original-bsd/lib/libc/gen/getfsent.3 (revision f1324ba5)
Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)getfsent.3 6.6 (Berkeley) 09/17/88

GETFSENT 3 ""
C 4
NAME
getfsent, getfsspec, getfsfile, setfsent, endfsent - get file system descriptor file entry
SYNOPSIS
 #include <fstab.h> 

struct fstab *getfsent()

struct fstab *getfsspec(spec) char *spec;

struct fstab *getfsfile(file) char *file;

int setfsent()

void endfsent()

DESCRIPTION
Getfsent , getfsspec , and getfsfile each return a pointer to an object with the following structure containing the broken-out fields of a line in the file system description file, < fstab.h >.

struct fstab {
 char *fs_spec;
 char *fs_file;
 char *fs_type;
 int fs_freq;
 int fs_passno;
};

The fields have meanings described in fstab (5).

Setfsent opens the file (closing any previously opened file) or rewinds it if it is already open.

Endfsent closes the file.

Getfsspec and getfsfile search the entire file (opening it if necessary) for a matching special file name or file system file name.

For programs wishing to read the entire database, getfsent reads the next entry (opening the file if necessary).

All entries in the file with a type field equivalent to FSTAB_XX are ignored.

FILES
/etc/fstab
"SEE ALSO"
fstab(5)
DIAGNOSTICS
Getfsent , getfsspec , and getfsfile return a null pointer (0) on EOF or error. Setfsent returns 0 on failure, 1 on success. Endfsent returns nothing.
BUGS
All information is contained in a static area so it must be copied if it is to be saved.