blk_fetch()

Purpose

Fetches more than one record at a time

Syntax (CCOWN)

int blk_fetch(int nr, int flags, short *datarec, int index, int role, ADDITIONAL)

Syntax (DP4DBAPI)

int dp4_blk_fetch(DCONN * dconn, int number, short * datarec, int flags, int index_rec, int index_role, int match_keys);

Parameters

DCONN * dconn

Handle to database connection

 

int nr

Number of records to fetch

 

int flags

Indicates the search method used, as for the functions rec_fetch()

 

short * datarec

Pointer to the L field of a database record to be fetched. Note that this field must be a pointer to an array of records, matching the number of records requested in the first parameter, otherwise blk_fetch() may write to other data areas

 

int index

Index number of the index used

 

int role

Role number of the index used

 

int match_keys

Number of leading keys to match for searches other than EQUAL. In the CCOWN version of the API this is the optional ADDITIONAL parameter, and is ignored unless you specify DEPTH as one of the flags.

Description

The blk_fetch() function is a generalised version of the function rec_fetch(), which allows more than one record to be read from the database at a time.

In general, you are recommended to use the bf_fetch() function instead of blk_fetch().

Return values

Returns the number of records actually fetched.

See also

rec_fetch(), bf_fetch()