NAME

SYNOPSIS

#include <dce/dce.h>
#include <dce/dbif.h>

void dce_db_iter_start(
    dce_db_handle_t handle,
    error_status_t *status);

PARAMETERS

Input

handle

A handle, returned from dce_db_open(), that identifies the backing store being used.

Output

status

A pointer to the completion status. On successful completion, the routine returns error_status_ok.

DESCRIPTION

The dce_db_iter_start() routine prepares the backing store that is identified by the handle parameter for iterative retrieval of all its keys in succession.

A given handle can support only a single instance of iteration at one time.

To avoid the possibility that another thread will write to the backing store during an iteration, always use the dce_db_lock() routine before calling dce_db_iter_start().

ERRORS

db_s_iter_not_allowed

The function was called while an iteration was already in progress. The concept of nested iterations is not supported.

error_status_ok

The call was successful.

RELATED INFORMATION

Functions: dce_db_iter_done(3dce), dce_db_iter_next(3dce), dce_db_iter_next_by_name(3dce), dce_db_iter_next_by_uuid(3dce), dce_db_lock(3dce), dce_db_unlock(3dce), dce_db_open(3dce).