dbbylist

Description

Return the bylist for a compute row.

Syntax

BYTE *dbbylist(dbproc, computeid, size)
 
DBPROCESS    *dbproc;
int                      computeid;
int                      *size;

Parameters

dbproc

A pointer to the DBPROCESS structure that provides the connection for a particular front-end/server process. It contains all the information that DB-Library uses to manage communications and data between the front end and server.

computeid

The ID that identifies the particular compute row of interest. A SQL select statement may have multiple compute clauses, each of which returns a separate compute row. The computeid corresponding to the first compute clause in a select is 1. The computeid is returned by dbnextrow or dbgetrow.

size

A pointer to an integer, which dbbylist sets to the number of elements in the bylist.

Returns

A pointer to an array of bytes containing the numbers of the columns that compose the bylist for the specified compute. The array of BYTEs is part of the DBPROCESS, so you must not free it. If the computeid is out of range, NULL is returned.

Call dbcolname to derive the name of a column from its number.

The size of the array is returned in the size parameter. A size of 0 indicates that either there is no bylist for this particular compute or the computeid is out of range.

Usage

See also

dbadata, dbadlen, dbaltlen, dbalttype, dbcolname, dbgetrow, dbnextrow