svn_iter.h File Reference

The Subversion Iteration drivers helper routines. More...

#include <apr_hash.h>
#include "svn_types.h"
#include "svn_error.h"

Go to the source code of this file.

Typedefs

typedef svn_error_t *(* svn_iter_apr_hash_cb_t )(void *baton, const void *key, apr_ssize_t klen, void *val, apr_pool_t *pool)
 Callback function for use with svn_iter_apr_hash().
typedef svn_error_t *(* svn_iter_apr_array_cb_t )(void *baton, void *item, apr_pool_t *pool)
 Iteration callback used in conjuction with svn_iter_apr_array().

Functions

svn_error_tsvn_iter_apr_hash (svn_boolean_t *completed, apr_hash_t *hash, svn_iter_apr_hash_cb_t func, void *baton, apr_pool_t *pool)
 Iterate over the elements in hash, calling func for each one until there are no more elements or func returns an error.
svn_error_tsvn_iter_apr_array (svn_boolean_t *completed, const apr_array_header_t *array, svn_iter_apr_array_cb_t func, void *baton, apr_pool_t *pool)
 Iterate over the elements in array calling func for each one until there are no more elements or func returns an error.
svn_error_tsvn_iter__break (void)
 Internal routine used by svn_iter_break() macro.


Detailed Description

The Subversion Iteration drivers helper routines.

Definition in file svn_iter.h.


Typedef Documentation

typedef svn_error_t*(* svn_iter_apr_array_cb_t)(void *baton, void *item, apr_pool_t *pool)

Iteration callback used in conjuction with svn_iter_apr_array().

Use pool for temporary allocation, it's cleared between invocations.

baton is the baton passed to svn_iter_apr_array(). item is a pointer to the item written to the array with the APR_ARRAY_PUSH() macro.

Since:
New in 1.5.

Definition at line 77 of file svn_iter.h.

typedef svn_error_t*(* svn_iter_apr_hash_cb_t)(void *baton, const void *key, apr_ssize_t klen, void *val, apr_pool_t *pool)

Callback function for use with svn_iter_apr_hash().

Use pool for temporary allocation, it's cleared between invocations.

key, klen and val are the values normally retrieved with apr_hash_this().

baton is the baton passed into svn_iter_apr_hash().

Since:
New in 1.5.

Definition at line 40 of file svn_iter.h.


Function Documentation

svn_error_t* svn_iter_apr_array ( svn_boolean_t completed,
const apr_array_header_t *  array,
svn_iter_apr_array_cb_t  func,
void *  baton,
apr_pool_t *  pool 
)

Iterate over the elements in array calling func for each one until there are no more elements or func returns an error.

Uses pool for temporary allocations.

On return - if func returns no errors - *completed will be set to TRUE.

If func returns an error other than SVN_ERR_ITER_BREAK, that error is returned. When func returns SVN_ERR_ITER_BREAK, iteration is interrupted, but no error is returned and *completed is set to FALSE.

Since:
New in 1.5.

svn_error_t* svn_iter_apr_hash ( svn_boolean_t completed,
apr_hash_t *  hash,
svn_iter_apr_hash_cb_t  func,
void *  baton,
apr_pool_t *  pool 
)

Iterate over the elements in hash, calling func for each one until there are no more elements or func returns an error.

Uses pool for temporary allocations.

On return - if func returns no errors - *completed will be set to TRUE.

If func returns an error other than SVN_ERR_ITER_BREAK, that error is returned. When func returns SVN_ERR_ITER_BREAK, iteration is interrupted, but no error is returned and *completed is set to FALSE.

Since:
New in 1.5.


Generated on Sat Jun 28 07:30:53 2008 for Subversion by  doxygen 1.5.5