diff options
Diffstat (limited to 'include/apr_file_info.h')
| -rw-r--r-- | include/apr_file_info.h | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/include/apr_file_info.h b/include/apr_file_info.h index cfddc68da..f08762cea 100644 --- a/include/apr_file_info.h +++ b/include/apr_file_info.h @@ -263,11 +263,33 @@ APR_DECLARE(apr_status_t) apr_dir_close(apr_dir_t *thedir); * not be filled in, and you need to check the @c finfo->valid bitmask * to verify that what you're looking for is there. When no more * entries are available, APR_ENOENT is returned. + * + * @warning Memory will be allocated in the pool passed to apr_dir_open; + * use apr_dir_pread() and a temporary pool to restrict memory + * consumption for a large directory. */ APR_DECLARE(apr_status_t) apr_dir_read(apr_finfo_t *finfo, apr_int32_t wanted, apr_dir_t *thedir); /** + * Read the next entry from the specified directory. + * @param finfo the file info structure and filled in by apr_dir_read + * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ + values + * @param thedir the directory descriptor returned from apr_dir_open + * @param pool the pool to use for allocations + * @remark No ordering is guaranteed for the entries read. + * + * @note If @c APR_INCOMPLETE is returned all the fields in @a finfo may + * not be filled in, and you need to check the @c finfo->valid bitmask + * to verify that what you're looking for is there. When no more + * entries are available, APR_ENOENT is returned. + */ +APR_DECLARE(apr_status_t) apr_dir_pread(apr_finfo_t *finfo, apr_int32_t wanted, + apr_dir_t *thedir, apr_pool_t *pool); + + +/** * Rewind the directory to the first entry. * @param thedir the directory descriptor to rewind. */ |