NAME

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

handle

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

key

A string or UUID that is the backing store key.

Output

hdr

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

status

A 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_allocate(). 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

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).