Supported ODBC Functions

This quick-reference summary lists the ODBC API calls supported by the ODBC driver. API calls that are not supported return a SQL_ERROR. Each call is discussed in further detail in the following sections.

ODBC Call	Function
SQLAllocEnv	Allocates an environment handle for the ODBC connection.
SQLAllocConnect	Allocates a connection; returns a connection handle.
SQLAllocStmt	Allocates a statement handle for the specified connection.
SQLBindCol	Provides the buffer address for an answer column about to be fetched.
SQLBindParameter	Provides the value of a parameter (prompt variable) defined in the query.
SQLColAttributes	Returns result-column descriptor information for a result set.
SQLConnect	Connects to a PeopleSoft database.
SQLDescribeCol	Provides descriptors (data type and so on) for a result column.
SQLDescribeParam	Describes a parameter marker in a statement.
SQLDisconnect	Disconnects from the data source.
SQLDriverConnect	Connects to a PeopleSoft database, prompting the user for any login parameters not provided by the caller.
SQLError	Retrieves information about an error that occurred on a previous call.
SQLExecDirect	Prepares and executes a query. Note: Only the stored procedure syntax is supported.
SQLExecute	Executes a previously prepared query.
SQLFetch	Fetches a row of the answer set into the bound columns.
SQLFreeConnect	Closes the database connection and frees all resources that are associated with it.
SQLFreeStmt	Discards all resources that are associated with a previously prepared statement.
SQLGetData	Retrieves data for a specific column of the current fetched row. (Useful for long data, images, and so on.)
SQLGetFunctions	Tells applications which ODBC functions this driver supports.
SQLGetInfo	Retrieves information about the data source.
SQLGetRowCount	Returns the number of rows affected by the last execution.
SQLGetTypeInfo	Returns information about data types supported by the data source.
SQLNumParams	Returns the number of parameters in a statement.
SQLNumResultCols	Returns the number of result columns in the answer set of a prepared query.
SQLPrepare	Prepares a query for execution.
SQLProcedureColumns	Provides a list of queries and result columns available to the current operator and matching the specified qualifiers.
SQLProcedures	Retrieves a list of available stored procedures (queries).
SQLTransact	Commits or rolls back the current transaction.

The ODBC functions in the following table are supported calls with no underlying functionality. These functions exist to ensure compatibility with ODBC applications:

ODBC Call	Function
SQLColumns	Retrieves column information from the database.
SQLForeignKeys	Retrieves database information concerning foreign keys.
SQLGetConnectOption	Gets connection option information.
SQLGetCursorName	Gets the name of the cursor.
SQLGetStmtOption	Gets statement option information.
SQLMoreResults	Returns whether or not another result set is pending.
SQLPrimaryKeys	Retrieves database information on primary keys.
SQLSetConnectOption	Sets database connection options.
SQLSetCursorName	Sets the name of the cursor to be used with the statement.
SQLSetScrollOptions	Sets options to control cursor scrolling.
SQLSetStmtOption	Sets options for the statement.
SQLSpecialColumns	Retrieves information about optimal keys or automatically incremented columns.
SQLStatistics	Retrieves statistics in tables and indices from the database.
SQLTables	Retrieves a list of tables or views in the database.