VMS Help  —  DCE  DCE_INTRO, dce_db_intro, dce_db_delete
 NAME
   dce_db_delete - Deletes an item from a backing store

 SYNOPSIS

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

   void dce_db_delete( dce_db_handle_t handle,
                       void *key,
                       error_status_t *status );

 PARAMETERS

   Input

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

   key       A pointer to a string or UUID that is the key to the
             item in the backing store.  The datatype of key must
             match the key method that was selected in the flags
             parameter to dce_db_open() when the backing store was
             created.

   Output

   status    A pointer to the completion status.  On successful
             completion, the routine returns error_status_ok.
             Otherwise, it returns an error code.

 DESCRIPTION

   The dce_db_delete() routine deletes an item from the backing store
   that is identified by the handle parameter, which was obtained from
   dce_db_open().  It is a general deletion routine, interpreting the
   key parameter according to the type of index with which the backing
   store was created.

 ERRORS

   db_s_del_failed
             The deletion did not occur.  The global variable errno
             may indicate further information about the error.

   db_s_bad_index_type
             The key's type is wrong, or the backing store is not by
             name or by UUID.

   db_s_iter_not_allowed
             The function was called while an iteration, begun by
             dce_db_iter_start(), was in progress.  Deletion is not
             allowed during iteration.

   error_status_ok
             The call was successful.

 RELATED INFORMATION

   Functions: dce_db_delete_by_name
              dce_db_delete_by_uuid
              dce_db_open
Close Help