Name

dce_db_header_fetch - Retrieves the header from a backing store

Synopsis

#include <dce/dce.h>
#include <dce/dbif.h> void dce_db_header_fetch(
    dce_db_handle_t handle,
    void ∗key,
    dce_db_header_t ∗hdr,
    error_status_t ∗status);

Parameters

Input

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

keyA string or UUID that is the backing store key. 

Output

hdrA pointer to a caller-supplied header structure to be filled in by the library. 

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

Description

The dce_db_header_fetch() routine returns a pointer to a copy of the header of the object in the backing store that is identified by the handle parameter, which was obtained from dce_db_open().  The caller must free the copy’s storage.  It was allocated (as with other fetch routines) through rpc_ss_alloc().  The key parameter is interpreted according to the type of index with which the backing store was created. 

The hdr parameter is shown as a pointer to an arbitrary data type.  In actual use it will be the address of the backing-store-specific data type. 

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. 

db_s_key_not_found
The key was not found in the backing store.

error_status_ok
The call was successful.

Related Information

Functions: dce_db_fetch(3dce), dce_db_std_header_init(3dce).