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