dbcursorinfo

DB Library for C

DB Library for C

dbcursorinfo

Returns the number of columns and the number of rows in the keyset for a client cursor, a transparent server cursor, or an explicit server cursor. The dbcursorinfoex function returns more detailed information.

Syntax

RETCODE dbcursorinfo (
PDBCURSOR
hcursor,
LPINT
ncols,
LPDBINT
nrows );

Arguments

hcursor

Is the cursor handle created by dbcursoropen.

ncols

Is a pointer to a program variable that will contain the number of columns in the cursor.

nrows

Is a pointer to a program variable that will contain the number of rows in a cursor result set.

Client cursor:

For a keyset cursor, this number is always valid. For a dynamic cursor, this number is valid only if the current fetch buffer contains the last row in the cursor result set; otherwise, - 1 is returned.

Transparent server cursor, explicit server cursor:

For a dynamic cursor, - 1 is returned.

For a keyset cursor, this value can be the number of rows populated if asynchronous population of the cursor result set is incomplete, or the total number of rows in the cursor result set. You can call dbcursorinfoex to determine this.

Returns

SUCCEED or FAIL.

Remarks

Call dbcursorinfoex for more complete information about transparent server cursors and explicit server cursors.

See Also

Bulk-Copy Functions

dbcursorcolinfo

dbcursor

dbcursorfetch

dbcursorbind

dbcursoropen

dbcursorclose