ftw.h(3)                   POSIX Programmer's Manual                  ftw.h(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.


NNAAMMEE
       ftw.h -- file tree traversal

SSYYNNOOPPSSIISS
       #include <ftw.h>

DDEESSCCRRIIPPTTIIOONN
       The _<_f_t_w_._h_> header shall define the FFTTWW structure, which shall include
       at least the following members:

           iinntt  bbaassee
           iinntt  lleevveell

       The _<_f_t_w_._h_> header shall define the following symbolic constants for
       use as values of the third argument to the application-supplied
       function that is passed as the second argument to _f_t_w() and _n_f_t_w():

       FTW_F         Non-directory file.

       FTW_D         Directory.

       FTW_DNR       Directory without read permission.

       FTW_DP        Directory with subdirectories visited.

       FTW_NS        Unknown type; _s_t_a_t() failed.

       FTW_SL        Symbolic link.

       FTW_SLN       Symbolic link that names a nonexistent file.

       The _<_f_t_w_._h_> header shall define the following symbolic constants for
       use as values of the fourth argument to _n_f_t_w():

       FTW_PHYS      Physical walk, does not follow symbolic links. Otherwise,
                     _n_f_t_w() follows links but does not walk down any path that
                     crosses itself.

       FTW_MOUNT     The walk does not cross a mount point.

       FTW_DEPTH     All subdirectories are visited before the directory
                     itself.

       FTW_CHDIR     The walk changes to each directory before reading it.

       The following shall be declared as functions and may also be defined as
       macros. Function prototypes shall be provided.

           iinntt ffttww((ccoonnsstt cchhaarr **,, iinntt ((**))((ccoonnsstt cchhaarr **,, ccoonnsstt ssttrruucctt ssttaatt **,,
               iinntt)),, iinntt));;
           iinntt nnffttww((ccoonnsstt cchhaarr **,, iinntt ((**))((ccoonnsstt cchhaarr **,, ccoonnsstt ssttrruucctt ssttaatt **,,
               iinntt,, ssttrruucctt FFTTWW **)),, iinntt,, iinntt));;

       The _<_f_t_w_._h_> header shall define the ssttaatt structure and the symbolic
       names for _s_t___m_o_d_e and the file type test macros as described in
       _<_s_y_s_/_s_t_a_t_._h_>.

       Inclusion of the _<_f_t_w_._h_> header may also make visible all symbols from
       _<_s_y_s_/_s_t_a_t_._h_>.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       <<ssyyss__ssttaatt..hh>>

       The System Interfaces volume of POSIX.1-2008, _f_t_w(), _n_f_t_w()

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
       -- Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, Copyright (C) 2013 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is
       POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
       event of any discrepancy between this version and the original IEEE and
       The Open Group Standard, the original IEEE and The Open Group Standard
       is the referee document. The original Standard can be obtained online
       at http://www.unix.org/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2013                             ftw.h(3)
