NAME
SQLcolNamesCursor - return the column names of the query associated with a tclsql cursor

SYNOPSIS
SQLcolNamesCursor cursor result_array [row_indice]

DESCRIPTION

The SQLcolNamesCursor command returns the column names associated with an SQL cursor. The column names are returned as row number row_indice in the Tcl array result_array. The return value of SQLcolNamesCursor is the number of columns in result_array.

If the optional argument row_indice is not present, then the Tcl array will be 1 dimensional, with the first column name stored in result_array(0), the second column name stored in result_array(1) and so on.

Note that only the column names are retrieved from the database, no row data is retrieved.

Before SQLcolNamesCursor can be called, one must call SQLdescribeCursor. SQLcolNamesCursor merely retrieves data that was stored during SQLdescribeCursor cursor call.

Note that the SQLcolNamesCursor command uses user defined, dynamically allocate cursors, whereas the SQLcolNamesSelect command uses a private statically allocated cursor.

OPTIONS

row_indice
    If the optional argument row_indice is present then the result_array will have the first column name in result_array(row_indice,0). row_indice need not be a number, but it usually is an integer greater than or equal to zero.

KEYWORDS
database, cursor

SEE ALSO
SQLcolNamesSelect(3)