glob.h(3)                  POSIX Programmer's Manual                 glob.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
       glob.h -- pathname pattern-matching types

SSYYNNOOPPSSIISS
       #include <glob.h>

DDEESSCCRRIIPPTTIIOONN
       The _<_g_l_o_b_._h_> header shall define the structures and symbolic constants
       used by the _g_l_o_b() function.

       The _<_g_l_o_b_._h_> header shall define the gglloobb__tt structure type, which shall
       include at least the following members:


           size_t   gl_pathc Count of paths matched by _p_a_t_t_e_r_n_.
           char   **gl_pathv Pointer to a list of matched pathnames.
           size_t   gl_offs  Slots to reserve at the beginning of _g_l___p_a_t_h_v_.

       The _<_g_l_o_b_._h_> header shall define the ssiizzee__tt type as described in
       _<_s_y_s_/_t_y_p_e_s_._h_>.

       The _<_g_l_o_b_._h_> header shall define the following symbolic constants as
       values for the _f_l_a_g_s argument:

       GLOB_APPEND   Append generated pathnames to those previously obtained.

       GLOB_DOOFFS   Specify how many null pointers to add to the beginning of
                     _g_l___p_a_t_h_v.

       GLOB_ERR      Cause _g_l_o_b() to return on error.

       GLOB_MARK     Each pathname that is a directory that matches _p_a_t_t_e_r_n
                     has a <slash> appended.

       GLOB_NOCHECK  If _p_a_t_t_e_r_n does not match any pathname, then return a
                     list consisting of only _p_a_t_t_e_r_n.

       GLOB_NOESCAPE Disable backslash escaping.

       GLOB_NOSORT   Do not sort the pathnames returned.

       The _<_g_l_o_b_._h_> header shall define the following symbolic constants as
       error return values:

       GLOB_ABORTED  The scan was stopped because GLOB_ERR was set or
                     (*_e_r_r_f_u_n_c)() returned non-zero.

       GLOB_NOMATCH  The pattern does not match any existing pathname, and
                     GLOB_NOCHECK was not set in _f_l_a_g_s.

       GLOB_NOSPACE  An attempt to allocate memory failed.

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


           int  glob(const char *restrict, int, int(*)(const char *, int),
                    glob_t *restrict);
           void globfree(glob_t *);

       _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__ttyyppeess..hh>>

       The System Interfaces volume of POSIX.1-2017, _g_l_o_b()

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  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.opengroup.org/unix/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                  2017                            glob.h(3)
