Name

dce_db_iter_done - Frees the state associated with iteration

Synopsis

#include <dce/dce.h>
#include <dce/dbif.h> void dce_db_iter_done(
    dce_db_handle_t handle,
    error_status_t ∗status);

Parameters

Input

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

Output

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

Description

The dce_db_iter_done() routine frees the state that permits iteration.  It should be called after an iteration through a backing store is finished. 

The iteration state is established by dce_db_iter_start().  The routines for performing iteration over the items are dce_db_iter_next(), dce_db_iter_next_by_name(), and dce_db_iter_next_by_uuid(). 

Errors

The following describes a partial list of errors that might be returned.  Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages. 

error_status_ok
The call was successful.

Related Information

Functions: dce_db_iter_next(3dce), dce_db_iter_next_by_name(3dce), dce_db_iter_next_by_uuid(3dce), dce_db_iter_start(3dce).