Difference between revisions of "Library ODBC Compatible Functions"

From Recital Documentation Wiki
Jump to: navigation, search
Line 1: Line 1:
 
On Recital supported UNIX and Linux platforms, the following ODBC compatible functions are also available in addition to the standard Recital/Library functions.
 
On Recital supported UNIX and Linux platforms, the following ODBC compatible functions are also available in addition to the standard Recital/Library functions.
 +
  
 
{| class="wikitable"
 
{| class="wikitable"
 
!FUNCTION||DESCRIPTION
 
!FUNCTION||DESCRIPTION
 
|-
 
|-
−
|SQLAllocConnect()||Allocate a connection handle.
+
|SQLAllocConnect() [http://msdn.microsoft.com/en-us/library/ms714852(VS.85).aspx]||Allocate a connection handle.
 
|-
 
|-
−
|SQLAllocEnv()||Allocate an environment handle.
+
|SQLAllocEnv() [http://msdn.microsoft.com/en-us/library/ms709270(VS.85).aspx]||Allocate an environment handle.
 
|-
 
|-
−
|SQLAllocStmt()||Allocate a new statement and associate it with a connection handle.
+
|SQLAllocStmt() [http://msdn.microsoft.com/en-us/library/ms712649(VS.85).aspx]||Allocate a new statement and associate it with a connection handle.
 
|-
 
|-
−
|SQLBindCol()||Bind application storage space to columns in a result set.
+
|SQLBindCol() [http://msdn.microsoft.com/en-us/library/ms711010(VS.85).aspx]||Bind application storage space to columns in a result set.
 
|-
 
|-
−
|SQLBindParameter()||Bind an application variable to a parameter marker.
+
|SQLBindParameter() [http://msdn.microsoft.com/en-us/library/ms710963(VS.85).aspx]||Bind an application variable to a parameter marker.
 
|-
 
|-
−
|SQLColAttributes()||Return descriptor information for a column.
+
|SQLColAttributes() [http://msdn.microsoft.com/en-us/library/ms711003(VS.85).aspx]||Return descriptor information for a column.
 
|-
 
|-
−
|SQLColumnPrivileges()||Return a list of columns and associated privileges for the specified table.
+
|SQLColumnPrivileges() [http://msdn.microsoft.com/en-us/library/ms716336(VS.85).aspx]||Return a list of columns and associated privileges for the specified table.
 
|-
 
|-
−
|SQLColumns()||Return a list of column names for the specified tables.
+
|SQLColumns() [http://msdn.microsoft.com/en-us/library/ms711683(VS.85).aspx]||Return a list of column names for the specified tables.
 
|-
 
|-
−
|SQLConnect()||Establish a connection to a database.
+
|SQLConnect() [http://msdn.microsoft.com/en-us/library/ms711683(VS.85).aspx]||Establish a connection to a database.
 
|-
 
|-
−
|SQLDataSources()||Return information about a data source.  This function is implemented solely by the Driver Manager.
+
|SQLDataSources() [http://msdn.microsoft.com/en-us/library/ms711004(VS.85).aspx]||Return information about a data source.  This function is implemented solely by the Driver Manager.
 
|-
 
|-
−
|SQLDescribeCol()||Return column information.
+
|SQLDescribeCol() [http://msdn.microsoft.com/en-us/library/ms716289(VS.85).aspx]||Return column information.
 
|-
 
|-
−
|SQLDescribeParam()||Return the description of a parameter marker.
+
|SQLDescribeParam() [http://msdn.microsoft.com/en-us/library/ms710188(VS.85).aspx]||Return the description of a parameter marker.
 
|-
 
|-
−
|SQLDisconnect()||Disconnect a connection from a database.
+
|SQLDisconnect() [http://msdn.microsoft.com/en-us/library/ms713946(VS.85).aspx]||Disconnect a connection from a database.
 
|-
 
|-
−
|SQLError()||Return information about the most recent error.
+
|SQLError() [http://msdn.microsoft.com/en-us/library/ms716312(VS.85).aspx]||Return information about the most recent error.
 
|-
 
|-
−
|SQLExecDirect()||Prepare and execute an SQL statement.
+
|SQLExecDirect() [http://msdn.microsoft.com/en-us/library/ms713611(VS.85).aspx]||Prepare and execute an SQL statement.
 
|-
 
|-
 
|SQLExecImmediate()||Execute an SQL statement.
 
|SQLExecImmediate()||Execute an SQL statement.
 
|-
 
|-
−
|SQLExecute()||Execute a previously prepared dynamic SQL statement.
+
|SQLExecute() [http://msdn.microsoft.com/en-us/library/ms713584(VS.85).aspx]||Execute a previously prepared dynamic SQL statement.
 
|-
 
|-
−
|SQLFetch()||Advance cursor to next row.
+
|SQLFetch() [http://msdn.microsoft.com/en-us/library/ms712424(VS.85).aspx]||Advance cursor to next row.
 
|-
 
|-
−
|SQLForeignKeys()||Return a list of foreign keys in the specified table.
+
|SQLForeignKeys() [http://msdn.microsoft.com/en-us/library/ms709315(VS.85).aspx]||Return a list of foreign keys in the specified table.
 
|-
 
|-
−
|SQLFreeConnect()||Free connection from a database.
+
|SQLFreeConnect() [http://msdn.microsoft.com/en-us/library/ms709370(VS.85).aspx]||Free connection from a database.
 
|-
 
|-
−
|SQLFreeEnv()||Free environment handle.
+
|SQLFreeEnv() [http://msdn.microsoft.com/en-us/library/ms710920(VS.85).aspx]||Free environment handle.
 
|-
 
|-
−
|SQLFreeStmt()||Close a cursor.
+
|SQLFreeStmt() [http://msdn.microsoft.com/en-us/library/ms709284(VS.85).aspx]||Close a cursor.
 
|-
 
|-
−
|SQLGetConnectOption()||Return the current setting of a connection option.
+
|SQLGetConnectOption() [http://msdn.microsoft.com/en-us/library/ms711815(VS.85).aspx]||Return the current setting of a connection option.
 
|-
 
|-
−
|SQLGetCursorName()||Associate a cursor name with a statement handle.
+
|SQLGetCursorName() [http://msdn.microsoft.com/en-us/library/ms716209(VS.85).aspx]||Associate a cursor name with a statement handle.
 
|-
 
|-
−
|SQLGetData()||Retrieve data for a single column in the result set.  It can be called multiple times to retrieve variable length data in parts.
+
|SQLGetData() [http://msdn.microsoft.com/en-us/library/ms715441(VS.85).aspx]||Retrieve data for a single column in the result set.  It can be called multiple times to retrieve variable length data in parts.
 
|-
 
|-
−
|SQLGetInfo()||Return general information about the currently connected DBMS.
+
|SQLGetInfo() [http://msdn.microsoft.com/en-us/library/ms711681(VS.85).aspx]||Return general information about the currently connected DBMS.
 
|-
 
|-
−
|SQLGetStmtOption()||Set options related to the HSTMT.
+
|SQLGetStmtOption() [http://msdn.microsoft.com/en-us/library/ms715385(VS.85).aspx]||Set options related to the HSTMT.
 
|-
 
|-
−
|SQLGetTypeInfo()||Return information about data types supported by the data source.
+
|SQLGetTypeInfo() [http://msdn.microsoft.com/en-us/library/ms714632(VS.85).aspx]||Return information about data types supported by the data source.
 
|-
 
|-
 
|SQLLockTable()||Apply the specified lock to the table.
 
|SQLLockTable()||Apply the specified lock to the table.
 
|-
 
|-
−
|SQLMoreResults()||Determine whether there are more results available on a statement containing SELECT, UPDATE, INSERT, or DELETE statements and, if so, initialize processing for those results.
+
|SQLMoreResults() [http://msdn.microsoft.com/en-us/library/ms714673(VS.85).aspx]||Determine whether there are more results available on a statement containing SELECT, UPDATE, INSERT, or DELETE statements and, if so, initialize processing for those results.
 
|-
 
|-
−
|SQLNativeSql()||Return the SQL string as translated by the driver.
+
|SQLNativeSql() [http://msdn.microsoft.com/en-us/library/ms714575(VS.85).aspx]||Return the SQL string as translated by the driver.
 
|-
 
|-
−
|SQLNumParams()||Return the number of parameter markers.
+
|SQLNumParams() [http://msdn.microsoft.com/en-us/library/ms715409(VS.85).aspx]||Return the number of parameter markers.
 
|-
 
|-
−
|SQLNumResultCols(l)||Returns the number of columns in a result set.
+
|SQLNumResultCols() [http://msdn.microsoft.com/en-us/library/ms715409(VS.85).aspx]||Returns the number of columns in a result set.
 
|-
 
|-
−
|SQLParamData()||Used in conjunction with SQLPutData to supply parameter data at statement execution time.
+
|SQLParamData() [http://msdn.microsoft.com/en-us/library/ms712366(VS.85).aspx]||Used in conjunction with SQLPutData to supply parameter data at statement execution time.
 
|-
 
|-
−
|SQLPrepare()||Associate a cursor name with a statement handle.
+
|SQLPrepare() [http://msdn.microsoft.com/en-us/library/ms710926(VS.85).aspx]||Associate a cursor name with a statement handle.
 
|-
 
|-
−
|SQLPrimaryKeys()||Return the column names that make up the primary key for a table.
+
|SQLPrimaryKeys() [http://msdn.microsoft.com/en-us/library/ms711005(VS.85).aspx]||Return the column names that make up the primary key for a table.
 
|-
 
|-
−
|SQLProcedureColumns()||Return a list of input and output parameters, as well as the columns that make up the result set for the specified procedures.
+
|SQLProcedureColumns() [http://msdn.microsoft.com/en-us/library/ms711701(VS.85).aspx]||Return a list of input and output parameters, as well as the columns that make up the result set for the specified procedures.
 
|-
 
|-
−
|SQLProcedures()||Return the list of procedure names stored in a specific data source.  Procedure is a generic term used to describe an executable object, or a named entity that can be invoked using input and output parameters.
+
|SQLProcedures() [http://msdn.microsoft.com/en-us/library/ms715368(VS.85).aspx]||Return the list of procedure names stored in a specific data source.  Procedure is a generic term used to describe an executable object, or a named entity that can be invoked using input and output parameters.
 
|-
 
|-
−
|SQLPutData()||Allow an application to send data for a parameter or column to the driver at statement execution time.
+
|SQLPutData() [http://msdn.microsoft.com/en-us/library/ms713824(VS.85).aspx]||Allow an application to send data for a parameter or column to the driver at statement execution time.
 
|-
 
|-
−
|SQLRowCount()||Build a scroll cursor.
+
|SQLRowCount() [http://msdn.microsoft.com/en-us/library/ms711835(VS.85).aspx]||Build a scroll cursor.
 
|-
 
|-
 
|SQLSavePoint()||Set or roll back a save point on the current transaction.
 
|SQLSavePoint()||Set or roll back a save point on the current transaction.
 
|-
 
|-
−
|SQLSetConnectOption()||Set connection options.
+
|SQLSetConnectOption() [http://msdn.microsoft.com/en-us/library/ms713564(VS.85).aspx]||Set connection options.
 
|-
 
|-
−
|SQLSetCursorName()||Associate a cursor name with a statement handle.
+
|SQLSetCursorName() [http://msdn.microsoft.com/en-us/library/ms711707(VS.85).aspx]||Associate a cursor name with a statement handle.
 
|-
 
|-
 
|SQLSetLocking()||Change the transaction locking type.
 
|SQLSetLocking()||Change the transaction locking type.
 
|-
 
|-
−
|SQLSetParam()||Bind application storage space to columns in a result set.
+
|SQLSetParam() [http://msdn.microsoft.com/en-us/library/ms710893(VS.85).aspx]||Bind application storage space to columns in a result set.
 
|-
 
|-
−
|SQLSetPos()||Set the cursor position.
+
|SQLSetPos() [http://msdn.microsoft.com/en-us/library/ms713507(VS.85).aspx]||Set the cursor position.
 
|-
 
|-
−
|SQLSetStmtOption()||Set SQL statement options.
+
|SQLSetStmtOption() [http://msdn.microsoft.com/en-us/library/ms713876(VS.85).aspx]||Set SQL statement options.
 
|-
 
|-
−
|SQLSpecialColumns()||Set up fetch for special column names.
+
|SQLSpecialColumns() [http://msdn.microsoft.com/en-us/library/ms714602(VS.85).aspx]||Set up fetch for special column names.
 
|-
 
|-
−
|SQLStatistics()||Retrieve a list of statistics about a single table and the indexes associated with the table.
+
|SQLStatistics() [http://msdn.microsoft.com/en-us/library/ms711022(VS.85).aspx]||Retrieve a list of statistics about a single table and the indexes associated with the table.
 
|-
 
|-
−
|SQLTablePrivileges()||Return a list of tables and the privileges associated with each table.
+
|SQLTablePrivileges() [http://msdn.microsoft.com/en-us/library/ms711022(VS.85).aspx]||Return a list of tables and the privileges associated with each table.
 
|-
 
|-
−
|SQLTables()||Return a list of table names in the specified data source.
+
|SQLTables() [http://msdn.microsoft.com/en-us/library/ms711831(VS.85).aspx]||Return a list of table names in the specified data source.
 
|-
 
|-
−
|SQLTransact()||Commit or roll back the current transaction.
+
|SQLTransact() [http://msdn.microsoft.com/en-us/library/ms711677(VS.85).aspx]||Commit or roll back the current transaction.
 
|-
 
|-
 
|}
 
|}
 +
  
 
NOTE: To use the ODBC compatible functions, the following shared object library must be loaded or linked into your application:
 
NOTE: To use the ODBC compatible functions, the following shared object library must be loaded or linked into your application:
 +
  
 
<path>/recital-X.X/shared/libodbc.recital.so
 
<path>/recital-X.X/shared/libodbc.recital.so
 +
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Library]]
 
[[Category:Library]]
 
[[Category:Reference]]
 
[[Category:Reference]]

Revision as of 14:41, 31 March 2009

On Recital supported UNIX and Linux platforms, the following ODBC compatible functions are also available in addition to the standard Recital/Library functions.


FUNCTION DESCRIPTION
SQLAllocConnect() [1] Allocate a connection handle.
SQLAllocEnv() [2] Allocate an environment handle.
SQLAllocStmt() [3] Allocate a new statement and associate it with a connection handle.
SQLBindCol() [4] Bind application storage space to columns in a result set.
SQLBindParameter() [5] Bind an application variable to a parameter marker.
SQLColAttributes() [6] Return descriptor information for a column.
SQLColumnPrivileges() [7] Return a list of columns and associated privileges for the specified table.
SQLColumns() [8] Return a list of column names for the specified tables.
SQLConnect() [9] Establish a connection to a database.
SQLDataSources() [10] Return information about a data source. This function is implemented solely by the Driver Manager.
SQLDescribeCol() [11] Return column information.
SQLDescribeParam() [12] Return the description of a parameter marker.
SQLDisconnect() [13] Disconnect a connection from a database.
SQLError() [14] Return information about the most recent error.
SQLExecDirect() [15] Prepare and execute an SQL statement.
SQLExecImmediate() Execute an SQL statement.
SQLExecute() [16] Execute a previously prepared dynamic SQL statement.
SQLFetch() [17] Advance cursor to next row.
SQLForeignKeys() [18] Return a list of foreign keys in the specified table.
SQLFreeConnect() [19] Free connection from a database.
SQLFreeEnv() [20] Free environment handle.
SQLFreeStmt() [21] Close a cursor.
SQLGetConnectOption() [22] Return the current setting of a connection option.
SQLGetCursorName() [23] Associate a cursor name with a statement handle.
SQLGetData() [24] Retrieve data for a single column in the result set. It can be called multiple times to retrieve variable length data in parts.
SQLGetInfo() [25] Return general information about the currently connected DBMS.
SQLGetStmtOption() [26] Set options related to the HSTMT.
SQLGetTypeInfo() [27] Return information about data types supported by the data source.
SQLLockTable() Apply the specified lock to the table.
SQLMoreResults() [28] Determine whether there are more results available on a statement containing SELECT, UPDATE, INSERT, or DELETE statements and, if so, initialize processing for those results.
SQLNativeSql() [29] Return the SQL string as translated by the driver.
SQLNumParams() [30] Return the number of parameter markers.
SQLNumResultCols() [31] Returns the number of columns in a result set.
SQLParamData() [32] Used in conjunction with SQLPutData to supply parameter data at statement execution time.
SQLPrepare() [33] Associate a cursor name with a statement handle.
SQLPrimaryKeys() [34] Return the column names that make up the primary key for a table.
SQLProcedureColumns() [35] Return a list of input and output parameters, as well as the columns that make up the result set for the specified procedures.
SQLProcedures() [36] Return the list of procedure names stored in a specific data source. Procedure is a generic term used to describe an executable object, or a named entity that can be invoked using input and output parameters.
SQLPutData() [37] Allow an application to send data for a parameter or column to the driver at statement execution time.
SQLRowCount() [38] Build a scroll cursor.
SQLSavePoint() Set or roll back a save point on the current transaction.
SQLSetConnectOption() [39] Set connection options.
SQLSetCursorName() [40] Associate a cursor name with a statement handle.
SQLSetLocking() Change the transaction locking type.
SQLSetParam() [41] Bind application storage space to columns in a result set.
SQLSetPos() [42] Set the cursor position.
SQLSetStmtOption() [43] Set SQL statement options.
SQLSpecialColumns() [44] Set up fetch for special column names.
SQLStatistics() [45] Retrieve a list of statistics about a single table and the indexes associated with the table.
SQLTablePrivileges() [46] Return a list of tables and the privileges associated with each table.
SQLTables() [47] Return a list of table names in the specified data source.
SQLTransact() [48] Commit or roll back the current transaction.


NOTE: To use the ODBC compatible functions, the following shared object library must be loaded or linked into your application:


<path>/recital-X.X/shared/libodbc.recital.so

Retrieved from "https://www.recitalsoftware.com/wiki/index.php?title=Library_ODBC_Compatible_Functions&oldid=4730"