NAME

ftw.h - file tree traversal

 SYNOPSIS

#include <ftw.h>

 DESCRIPTION

The <ftw.h> header defines the FTW structure that includes at least the following members:

int  base
int  level

The <ftw.h> header defines macros for use as values of the third argument to the application-supplied function that is passed as the second argument to ftw() and nftw():

FTW_F

File.

FTW_D

Directory.

FTW_DNR

Directory without read permission.

FTW_DP

Directory with subdirectories visited.

FTW_NS

Unknown type, stat() failed.

FTW_SL

Symbolic link.

FTW_SLN

Symbolic link that names a non-existent file.

The <ftw.h> header defines macros for use as values of the fourth argument to nftw():

FTW_PHYS

Physical walk, does not follow symbolic links. Otherwise, nftw() will follow links but will not walk down any path that crosses itself.

FTW_MOUNT

The walk will not cross a mount point.

FTW_DEPTH

All subdirectories will be visited before the directory itself.

FTW_CHDIR

The walk will change to each directory before reading it.

The following are declared as functions and may also be defined as macros. Function prototypes must be provided for use with an ISO C compiler.

int ftw(const char *,
    int (*)(const char *, const struct stat *, int), int);
int nftw(const char *, int (*)
    (const char *, const struct stat *, int, struct FTW*),
    int, int);

The <ftw.h> header defines the stat structure and the symbolic names for st_mode and the file type test macros as described in <sys/stat.h>.

Inclusion of the <ftw.h> header may also make visible all symbols from <sys/stat.h>.

 APPLICATION USAGE

None.

 FUTURE DIRECTIONS

None.

 SEE ALSO

ftw(), nftw(), <sys/stat.h>.