1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/glob.dosc Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,253 @@
1.4 +/** @file ../include/glob.h
1.5 +@internalComponent
1.6 +*/
1.7 +
1.8 +/** @struct glob_t
1.9 +
1.10 +Includes the following members,
1.11 +
1.12 +@publishedAll
1.13 +@externallyDefinedApi
1.14 +*/
1.15 +
1.16 +/** @var glob_t::gl_pathc
1.17 +Count of total paths so far.
1.18 +*/
1.19 +
1.20 +/** @var glob_t::gl_matchc
1.21 +Count of paths matching pattern
1.22 +*/
1.23 +
1.24 +/** @var glob_t::gl_offs
1.25 +Reserved at beginning of gl_pathv.
1.26 +*/
1.27 +
1.28 +/** @var glob_t::gl_flags
1.29 +Copy of flags parameter to glob.
1.30 +*/
1.31 +
1.32 +/** @var glob_t::gl_pathv
1.33 +List of paths matching pattern.
1.34 +*/
1.35 +
1.36 +/** @var glob_t::gl_closedir
1.37 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.38 +*/
1.39 +
1.40 +/** @var glob_t::gl_stat
1.41 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.42 +*/
1.43 +
1.44 +/** @var glob_t::gl_opendir
1.45 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.46 +*/
1.47 +
1.48 +/** @var glob_t::gl_lstat
1.49 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.50 +*//** @struct glob64_t
1.51 +
1.52 +Includes the following members,
1.53 +
1.54 +@publishedAll
1.55 +@externallyDefinedApi
1.56 +*/
1.57 +
1.58 +/** @var glob64_t::gl_pathc
1.59 +Count of total paths so far.
1.60 +*/
1.61 +
1.62 +/** @var glob64_t::gl_matchc
1.63 +Count of paths matching pattern
1.64 +*/
1.65 +
1.66 +/** @var glob64_t::gl_offs
1.67 +Reserved at beginning of gl_pathv.
1.68 +*/
1.69 +
1.70 +/** @var glob64_t::gl_flags
1.71 +Copy of flags parameter to glob.
1.72 +*/
1.73 +
1.74 +/** @var glob64_t::gl_pathv
1.75 +List of paths matching pattern.
1.76 +*/
1.77 +
1.78 +/** @var glob64_t::gl_closedir
1.79 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.80 +*/
1.81 +
1.82 +/** @var glob64_t::gl_stat
1.83 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.84 +*/
1.85 +
1.86 +/** @var glob64_t::gl_opendir
1.87 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.88 +*/
1.89 +
1.90 +/** @var glob64_t::gl_lstat
1.91 +Alternate filesystem access methods for glob; replacement versions of closedir(3), readdir(3), opendir(3), stat(2) and lstat(2).
1.92 +*/
1.93 +
1.94 +/** @fn glob(const char *, int, int (*)(const char *, int), glob_t *)
1.95 +
1.96 +generate pathnames matching a pattern.
1.97 +The glob() function shall match all accessible pathnames against this pattern and develop a list of all pathnames that match.
1.98 +
1.99 +@publishedAll
1.100 +@externallyDefinedApi
1.101 +*/
1.102 +
1.103 +/** @fn glob64(const char *, int, int (*)(const char *, int), glob64_t *)
1.104 +
1.105 +glob64() is a large-file version of the glob()
1.106 +The glob64() function shall match all accessible pathnames against this pattern and develop a list of all pathnames that match.
1.107 +
1.108 +For full documentation see: http://www.unix.org/version2/whatsnew/lfs20mar.html#3.0
1.109 +
1.110 +@publishedAll
1.111 +@externallyDefinedApi
1.112 +*/
1.113 +
1.114 +/** @fn globfree(glob_t *)
1.115 +
1.116 +generate pathnames matching a pattern
1.117 +
1.118 +@publishedAll
1.119 +@externallyDefinedApi
1.120 +*/
1.121 +
1.122 +/** @fn globfree64(glob64_t *)
1.123 +
1.124 +globfree64() frees the dynamically allocated storage from an earlier call to glob64().
1.125 +globfree64() is a 64-bit version of globfree().
1.126 +
1.127 +@publishedAll
1.128 +@externallyDefinedApi
1.129 +*/
1.130 +
1.131 +/** @def GLOB_APPEND
1.132 +
1.133 +Append to output from previous call.
1.134 +
1.135 +@publishedAll
1.136 +@externallyDefinedApi
1.137 +*/
1.138 +
1.139 +
1.140 +/** @def GLOB_DOOFFS
1.141 +
1.142 +Use gl_offs.
1.143 +
1.144 +@publishedAll
1.145 +@externallyDefinedApi
1.146 +*/
1.147 +
1.148 +
1.149 +/** @def GLOB_ERR
1.150 +
1.151 +Return on error.
1.152 +
1.153 +@publishedAll
1.154 +@externallyDefinedApi
1.155 +*/
1.156 +
1.157 +
1.158 +/** @def GLOB_MARK
1.159 +
1.160 +Append / to matching directories.
1.161 +
1.162 +@publishedAll
1.163 +@externallyDefinedApi
1.164 +*/
1.165 +
1.166 +
1.167 +/** @def GLOB_NOCHECK
1.168 +
1.169 +Return pattern itself if nothing matches.
1.170 +
1.171 +@publishedAll
1.172 +@externallyDefinedApi
1.173 +*/
1.174 +
1.175 +/** @def GLOB_NOSORT
1.176 +
1.177 +Don't sort.
1.178 +
1.179 +@publishedAll
1.180 +@externallyDefinedApi
1.181 +*/
1.182 +
1.183 +/** @def GLOB_NOSPACE
1.184 +
1.185 +Error values returned by glob(3). Malloc call failed.
1.186 +
1.187 +@publishedAll
1.188 +@externallyDefinedApi
1.189 +*/
1.190 +
1.191 +/** @def GLOB_ABORTED
1.192 +
1.193 +Error values returned by glob(3). Unignored error.
1.194 +
1.195 +@publishedAll
1.196 +@externallyDefinedApi
1.197 +*/
1.198 +
1.199 +/** @def GLOB_NOMATCH
1.200 +
1.201 +Error values returned by glob(3). No match and GLOB_NOCHECK was not set.
1.202 +
1.203 +@publishedAll
1.204 +@externallyDefinedApi
1.205 +*/
1.206 +
1.207 +
1.208 +/** @def GLOB_ALTDIRFUNC
1.209 +
1.210 +Use alternately specified directory funcs.
1.211 +
1.212 +@publishedAll
1.213 +@externallyDefinedApi
1.214 +*/
1.215 +
1.216 +/** @def GLOB_BRACE
1.217 +
1.218 +Expand braces ala csh.
1.219 +
1.220 +@publishedAll
1.221 +@externallyDefinedApi
1.222 +*/
1.223 +
1.224 +/** @def GLOB_QUOTE
1.225 +
1.226 +Quote special chars with \\.
1.227 +
1.228 +@publishedAll
1.229 +@externallyDefinedApi
1.230 +*/
1.231 +
1.232 +/** @def GLOB_TILDE
1.233 +
1.234 +Expand tilde names from the passwd file.
1.235 +
1.236 +@publishedAll
1.237 +@externallyDefinedApi
1.238 +*/
1.239 +
1.240 +/** @def GLOB_LIMIT
1.241 +
1.242 +limit number of returned paths
1.243 +
1.244 +@publishedAll
1.245 +@externallyDefinedApi
1.246 +*/
1.247 +
1.248 +
1.249 +/** @def GLOB_NOMAGIC
1.250 +
1.251 +GLOB_NOCHECK without magic chars (csh).
1.252 +
1.253 +@publishedAll
1.254 +@externallyDefinedApi
1.255 +*/
1.256 +