genericopenlibs/openenvcore/include/glob.dosc
changeset 0 e4d67989cc36
equal deleted inserted replaced
-1:000000000000 0:e4d67989cc36
       
     1 /** @file  ../include/glob.h
       
     2 @internalComponent
       
     3 */
       
     4 
       
     5 /** @struct glob_t
       
     6 
       
     7 Includes the following members,
       
     8 
       
     9 @publishedAll
       
    10 @externallyDefinedApi
       
    11 */
       
    12 
       
    13 /** @var glob_t::gl_pathc
       
    14 Count of total paths so far.
       
    15 */
       
    16 
       
    17 /** @var glob_t::gl_matchc
       
    18 Count of paths matching pattern
       
    19 */
       
    20 
       
    21 /** @var glob_t::gl_offs
       
    22 Reserved at beginning of gl_pathv.
       
    23 */
       
    24 
       
    25 /** @var glob_t::gl_flags
       
    26 Copy of flags parameter to glob.
       
    27 */
       
    28 
       
    29 /** @var glob_t::gl_pathv
       
    30 List of paths matching pattern.
       
    31 */
       
    32 
       
    33 /** @var glob_t::gl_closedir
       
    34 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    35 */
       
    36 
       
    37 /** @var glob_t::gl_stat
       
    38 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    39 */
       
    40 
       
    41 /** @var glob_t::gl_opendir
       
    42 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    43 */
       
    44 
       
    45 /** @var glob_t::gl_lstat
       
    46 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    47 *//** @struct glob64_t
       
    48 
       
    49 Includes the following members,
       
    50 
       
    51 @publishedAll
       
    52 @externallyDefinedApi
       
    53 */
       
    54 
       
    55 /** @var glob64_t::gl_pathc
       
    56 Count of total paths so far.
       
    57 */
       
    58 
       
    59 /** @var glob64_t::gl_matchc
       
    60 Count of paths matching pattern
       
    61 */
       
    62 
       
    63 /** @var glob64_t::gl_offs
       
    64 Reserved at beginning of gl_pathv.
       
    65 */
       
    66 
       
    67 /** @var glob64_t::gl_flags
       
    68 Copy of flags parameter to glob.
       
    69 */
       
    70 
       
    71 /** @var glob64_t::gl_pathv
       
    72 List of paths matching pattern.
       
    73 */
       
    74 
       
    75 /** @var glob64_t::gl_closedir
       
    76 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    77 */
       
    78 
       
    79 /** @var glob64_t::gl_stat
       
    80 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    81 */
       
    82 
       
    83 /** @var glob64_t::gl_opendir
       
    84 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    85 */
       
    86 
       
    87 /** @var glob64_t::gl_lstat
       
    88 Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
       
    89 */
       
    90 
       
    91 /** @fn glob(const char *, int, int (*)(const char *, int), glob_t *)
       
    92 
       
    93 generate pathnames matching a pattern.
       
    94 The glob() function shall match all accessible pathnames against this pattern and develop a list of all pathnames that match. 
       
    95 
       
    96 @publishedAll
       
    97 @externallyDefinedApi
       
    98 */
       
    99 
       
   100 /** @fn glob64(const char *, int, int (*)(const char *, int), glob64_t *)
       
   101 
       
   102 glob64() is a large-file version of the glob()
       
   103 The glob64() function shall match all accessible pathnames against this pattern and develop a list of all pathnames that match. 
       
   104 
       
   105 For full documentation see: http://www.unix.org/version2/whatsnew/lfs20mar.html#3.0
       
   106 
       
   107 @publishedAll
       
   108 @externallyDefinedApi
       
   109 */
       
   110 
       
   111 /** @fn globfree(glob_t *)
       
   112 
       
   113 generate pathnames matching a pattern
       
   114 
       
   115 @publishedAll
       
   116 @externallyDefinedApi
       
   117 */
       
   118 
       
   119 /** @fn globfree64(glob64_t *)
       
   120 
       
   121 globfree64() frees the dynamically allocated storage from an earlier call to glob64().
       
   122 globfree64() is a 64-bit version of globfree().
       
   123 
       
   124 @publishedAll
       
   125 @externallyDefinedApi
       
   126 */
       
   127 
       
   128 /** @def GLOB_APPEND
       
   129 
       
   130 Append to output from previous call.
       
   131 
       
   132 @publishedAll
       
   133 @externallyDefinedApi
       
   134 */
       
   135 
       
   136 
       
   137 /** @def GLOB_DOOFFS
       
   138 
       
   139 Use gl_offs.
       
   140 
       
   141 @publishedAll
       
   142 @externallyDefinedApi
       
   143 */
       
   144 
       
   145 
       
   146 /** @def GLOB_ERR
       
   147 
       
   148 Return on error.
       
   149 
       
   150 @publishedAll
       
   151 @externallyDefinedApi
       
   152 */
       
   153 
       
   154 
       
   155 /** @def GLOB_MARK
       
   156 
       
   157 Append / to matching directories. 
       
   158 
       
   159 @publishedAll
       
   160 @externallyDefinedApi
       
   161 */
       
   162 
       
   163 
       
   164 /** @def GLOB_NOCHECK
       
   165 
       
   166 Return pattern itself if nothing matches.
       
   167 
       
   168 @publishedAll
       
   169 @externallyDefinedApi
       
   170 */
       
   171 
       
   172 /** @def GLOB_NOSORT
       
   173 
       
   174 Don't sort. 
       
   175 
       
   176 @publishedAll
       
   177 @externallyDefinedApi
       
   178 */
       
   179 
       
   180 /** @def GLOB_NOSPACE
       
   181 
       
   182 Error values returned by glob(3). Malloc call failed.
       
   183 
       
   184 @publishedAll
       
   185 @externallyDefinedApi
       
   186 */
       
   187 
       
   188 /** @def GLOB_ABORTED
       
   189 
       
   190 Error values returned by glob(3). Unignored error.
       
   191 
       
   192 @publishedAll
       
   193 @externallyDefinedApi
       
   194 */
       
   195 
       
   196 /** @def GLOB_NOMATCH
       
   197 
       
   198 Error values returned by glob(3). No match and GLOB_NOCHECK was not set. 
       
   199 
       
   200 @publishedAll
       
   201 @externallyDefinedApi
       
   202 */
       
   203 
       
   204 
       
   205 /** @def GLOB_ALTDIRFUNC
       
   206 
       
   207 Use alternately specified directory funcs.
       
   208 
       
   209 @publishedAll
       
   210 @externallyDefinedApi
       
   211 */
       
   212 
       
   213 /** @def GLOB_BRACE
       
   214 
       
   215 Expand braces ala csh. 
       
   216 
       
   217 @publishedAll
       
   218 @externallyDefinedApi
       
   219 */
       
   220 
       
   221 /** @def GLOB_QUOTE
       
   222 
       
   223 Quote special chars with \\.
       
   224 
       
   225 @publishedAll
       
   226 @externallyDefinedApi
       
   227 */
       
   228 
       
   229 /** @def GLOB_TILDE
       
   230 
       
   231 Expand tilde names from the passwd file.
       
   232 
       
   233 @publishedAll
       
   234 @externallyDefinedApi
       
   235 */
       
   236 
       
   237 /** @def GLOB_LIMIT
       
   238 
       
   239 limit number of returned paths
       
   240 
       
   241 @publishedAll
       
   242 @externallyDefinedApi
       
   243 */
       
   244 
       
   245 
       
   246 /** @def GLOB_NOMAGIC
       
   247 
       
   248 GLOB_NOCHECK without magic chars (csh).
       
   249 
       
   250 @publishedAll
       
   251 @externallyDefinedApi
       
   252 */
       
   253