SQLCOLUMNS()

Purpose

Store column information to a cursor

Syntax

SQLCOLUMNS(<nStatementHandle>, <cTableName> [, "FOXPRO" | "NATIVE"] [, <cCursorName>])

See Also

SQLCANCEL(), SQLCOMMIT(), SQLCONNECT(), SQLDISCONNECT(), SQLERROR(), SQLEXEC(), SQLGETPROP(), SQLMORERESULTS(), SQLPREPARE(), SQLROLLBACK(), SQLSETPROP(), SQLSTRINGCONNECT(), SQLTABLES()

Description

The SQLCOLUMNS() function is used to store column information for a specified data source table to a cursor.

The SQLCOLUMNS() function operates on the data source specified by <nStatementHandle>.

Keywords	Description
nStatementHandle	The workarea in which the gateway data source is open
cTableName	The table from which the column information should be returned
"FOXPRO" | "NATIVE"	Used to specify the format type for the column information. "NATIVE" is ignored, format type is always "FOXPRO".
cCursorName	The name of the cursor to use. If cCursorName is not specified, the default name SQLRESULT is used.

Cursor Columns:

Column	Description
Field_name	Column name
Field_type	Column data type
Field_len	Column length
Field_dec	Number of decimal places

Return values:

Return Value	Description
.F.	cTableName does not exist
1	The table was created successfully
0	SQLCOLUMNS() still executing
–1	Connection error
–2	Environment error

Example

nStatHand = sqlconnect("awhr")
if nStatHand < 1
	messagebox("Cannot make connection", 16, "SQL Connect Error")
else
	messagebox("Connection made", 48, "SQL Connect Message")
	nColEnd = sqlcolumns(nStatHand, "sales.currency")
	if nColEnd = 1
		select tabinfo
		list
	else
		messagebox("Table of Table Information could not be created")
	endif
	sqldisconnect(nStatHand)
endif