dbcursorcolinfo

Description

Return column information for the specified column number in the open cursor.

Syntax

RETCODE dbcursorcolinfo(hcursor, column, colname,
                      coltype, collen, usertype)
 
DBCURSOR      *hcursor
DBINT               column;
DBCHAR           *colname;
DBINT               *coltype;
DBINT               *collen;
DBINT               *usertype;

Parameters

hcursor: Cursor handle created by dbcursoropen.

column: Column number for which information is to be returned.

colname: Location where the name of the column is returned. The user should allocate space large enough to accommodate the column name.

coltype: Location where the column’s datatype is returned.

collen: Location where the column’s maximum length is returned.

usertype: Location where the column’s user-defined datatype is returned.

Returns

SUCCEED or FAIL.

Usage

Any of the parameters colname, coltype, collen, or usertype can be set to NULL, in which case the information for that variable is not returned.

For more information on cursors, see Appendix A, “Cursors.”