131 lines
15 KiB
HTML
131 lines
15 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Call Level Interface (CLI) APIs</title>
|
||
|
|
<!-- Begin Header Records ========================================== -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- 021001 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 030924 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 031106 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!--Java sync-link ================================================= -->
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Call Level Interface (CLI) APIs</h2>
|
||
|
|
|
||
|
|
<p>The CLI APIs are:</p>
|
||
|
|
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
|
||
|
|
<!-- Updates made in this section *will* be overlaid by automated tools -->
|
||
|
|
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
|
||
|
|
<!--***************API BEGIN PASTE***************-->
|
||
|
|
<ul>
|
||
|
|
<li><A HREF="../cli/rzadpfnastmt.htm">Allocate a statement handle</A> (SQLAllocStmt) allocates a new statement handle and associates it with the connection specified by the connection handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnacon.htm">Allocate connection handle</A> (SQLAllocConnect) allocates a connection handle and associated resources within the environment identified by the input environment handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnaenv.htm">Allocate environment handle</A> (SQLAllocEnv) allocates an environment handle and associated resources.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnahdl.htm">Allocate handle</A> (SQLAllocHandle) allocates any type of handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfncan.htm">Cancel statement</A> (SQLCancel) attempts to end the processing of an ongoing SQL statement operation that is executing asynchronously.</li>
|
||
|
|
<li><A HREF="../cli/rzadpclscur.htm">Close cursor statement</A> (SQLCloseCursor) closes the open cursor on a statement handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfncolat.htm">Column attributes</A> (SQLColAttributes) obtains an attribute for a column of the result set, and is also used to determine the number of columns.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnendtr.htm">Commit or roll back a transaction</A> (SQLEndTran) commits or rolls back the current transaction in the connection.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnconn.htm">Connect to a data source</A> (SQLConnect) establishes a connection to the target database.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfndvcon.htm">Connect to a data source (expanded)</A> (SQLDriverConnect) establishes a connection to the target database, but SQLDriverConnect() uses a connection string to determine the data source name, user ID and password.</li>
|
||
|
|
<li><A HREF="../cli/rzadpcpydesc.htm">Copy description statement</A> (SQLCopyDesc) copies the fields of the data structure associated with the source handle to the data structure associated with the target handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfndecol.htm">Describe column attributes</A> (SQLDescribeCol) returns the result descriptor information (column name, type, precision) for the indicated column in the result set generated by a SELECT statement.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnmrset.htm">Determine if there are more result sets</A> (SQLMoreResults) determines whether there is more information available on the statement handle which has been associated with a stored procedure that is returning result sets.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfndconn.htm">Disconnect from a data source</A> (SQLDisconnect) closes the connection associated with the database connection handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnexec.htm">Execute a statement</A> (SQLExecute) executes a statement, that was successfully prepared using SQLPrepare(), once or multiple times.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnexecd.htm">Execute a statement directly</A> (SQLExecDirect) executes the specified SQL statement.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnexfet.htm">Fetch array of rows</A> (SQLExtendedFetch) extends the function of SQLFetch() by returning a block of data containing multiple rows (called a rowset), in the form of an array, for each bound column.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfetchsc.htm">Fetch from a scrollable cursor</A> (SQLFetchScroll) positions the cursor based on the requested orientation, then retrieves any bound columns.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnfetch.htm">Fetch next row</A> (SQLFetch) advances the cursor to the next row of the result set, and retrieves any bound columns.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnfstmt.htm">Free (or reset) a statement handle</A> (SQLFreeStmt) ends processing on the statement referenced by the statement handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnfhdl.htm">Free a handle</A> (SQLFreeHandle) invalidates and frees a handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnfconn.htm">Free connection handle</A> (SQLFreeConnect) invalidates and frees the connection handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnfenv.htm">Free environment handle</A> (SQLFreeEnv) invalidates and frees the environment handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfncoln.htm">Get column information for a table</A> (SQLColumns) returns a list of columns in the specified tables.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngcurn.htm">Get cursor name</A> (SQLGetCursorName) returns the cursor name associated with the input statement handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngdata.htm">Get data from a column</A> (SQLGetData) retrieves data for a single column in the current row of the result set.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngtype.htm">Get data type information</A> (SQLGetTypeInfo) returns information about the data types that are supported by the DBMSs associated with DB2 UDB CLI. The information is returned in an SQL result set.</li>
|
||
|
|
<li><A HREF="../cli/rzadpgdesfld.htm">Get descriptor field</A> (SQLGetDescField) obtains a value from a descriptor.</li>
|
||
|
|
<li><A HREF="../cli/rzadpgdesrec.htm">Get descriptor record</A> (SQLGetDescRec) obtains an entire record from a descriptor.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngfunc.htm">Get functions</A> (SQLGetFunctions) queries whether a specific function is supported.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnginfo.htm">Get general information</A> (SQLGetInfo) returns general information, (including supported data conversions) about the DBMS that the application is currently connected to.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnstats.htm">Get index and statistics information for a base table</A> (SQLStatistics) retrieves index information for a given table.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnprcco.htm">Get input/output parameter information for a procedure</A> (SQLProcedureColumns) returns a list of input and output parameters associated with a procedure.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfndatas.htm">Get list of data sources</A> (SQLDataSources) returns a list of target databases available, one at a time.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnprcs.htm">Get list of procedure names</A> (SQLProcedures) returns a list of procedure names that have been registered at the server, and which match the specified search pattern.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnnsql.htm">Get native SQL text</A> (SQLNativeSql) is used to show how DB2 UDB CLI interprets vendor escape clauses.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnparad.htm">Get next parameter for which a data value is needed</A> (SQLParamData) is used with SQLPutData() to send long data in pieces.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnnump.htm">Get number of parameters in an SQL statement</A> (SQLNumParams) returns the number of parameter markers in an SQL statement.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnnrcol.htm">Get number of result columns</A> (SQLNumResultCols) returns the number of columns in the result set associated with the input statement handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnpkey.htm">Get primary key columns of a table</A> (SQLPrimaryKeys) returns a list of column names that comprise the primary key for a table.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfntablpriv.htm">Get privileges associated with a table</A> (SQLTablePrivileges) returns a list of tables and associated privileges for each table.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfncolnpriv.htm">Get privileges associated with the columns of a table</A> (SQLColumnPrivileges) returns a list of columns and associated privileges for the specified table.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnrowc.htm">Get row count</A> (SQLRowCount) returns the number of rows in a table affected by an UPDATE, INSERT, or DELETE statement executed against the table, or a view based on the table.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnspcol.htm">Get special (row identifier) columns</A> (SQLSpecialColumns) returns unique row identifier information (primary key or unique index) for a table.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfncolx.htm">Get SQL dialect or conformance information</A> (SQLLanguages) returns SQL dialect or conformance information.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfntabls.htm">Get table information</A> (SQLTables) returns a list of table names and associated information stored in the system catalogs of the connected data source.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnfkey.htm">Get the list of foreign key columns</A> (SQLForeignKeys) returns information about foreign keys for the specified table.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngcona.htm">Get the value of a connection attribute</A> (SQLGetConnectAttr) returns the current settings for the specified connection option.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngstma.htm">Get the value of a statement attribute</A> (SQLGetStmtAttr) returns the current settings of the specified statement attribute.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnpdata.htm">Passing data value for a parameter</A> (SQLPutData) is called following an SQLParamData() call returning SQL_NEED_DATA to supply parameter data values.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnprep.htm">Prepare a statement</A> (SQLPrepare) associates an SQL statement with the input statement handle and sends the statement to the DBMS to be prepared.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnnxtres.htm">Process the next result set</A> (SQLNextResult) determines whether there is more information available on the statement handle which has been associated with a stored procedure that is returning result sets.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnrelv.htm">Release all environment resources</A> (SQLReleaseEnv) invalidates and frees the environment handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnerror.htm">Retrieve error information</A> (SQLError) returns the diagnostic information associated with the most recently called DB2 UDB CLI function for a particular statement, connection or environment handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngtlen.htm">Retrieve length of a string value</A> (SQLGetLength) is used to retrieve the length of a large object value, referenced by a large object locator that has been returned from the server (as a result of a fetch, or an SQLGetSubString() call) during the current transaction.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngcol.htm">Retrieve one column of a row of the result set</A> (SQLGetCol) retrieves data for a single column in the current row of the result set.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngtsbs.htm">Retrieve portion of a string value</A> (SQLGetSubString) is used to retrieve a portion of a large object value, referenced by a large object locator that has been returned from the server (returned by a fetch or a previous SQLGetSubString() call) during the current transaction.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfndescprm.htm">Return description of a parameter marker</A> (SQLDescribeParam) returns the description of a parameter marker associated with a prepared SQL statement.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfndrec.htm">Return diagnostic information (concise)</A> (SQLGetDiagRec) returns the diagnostic information associated with the most recently called DB2 UDB CLI function for a particular statement, connection or environment handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfndfld.htm">Return diagnostic information (extensible)</A> (SQLGetDiagField) returns the diagnostic information associated with the most recently called DB2 UDB CLI function for a particular statement, connection or environment handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngtpos.htm">Return starting position of string</A> (SQLGetPosition) is used to return the starting position of one string within a LOB value (the source).</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngcono.htm">Returns current setting of a connect option</A> (SQLGetConnectOption) returns the current settings for the specified connection option.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngstmo.htm">Returns current setting of a statement option</A> (SQLGetStmtOption) returns the current settings of the specified statement option.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfngenva.htm">Returns current setting of an environment attribute</A> (SQLGetEnvAttr) returns the current settings for the specified environment attribute.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnsconx.htm">Set a connection attribute</A> (SQLSetConnectAttr) sets connection attributes for a particular connection.</li>
|
||
|
|
<li><A HREF="../cli/rzadpsetdesc.htm">Set a descriptor field</A> (SQLSetDescField) sets a field in a descriptor.</li>
|
||
|
|
<li><A HREF="../cli/rzadpsetrec.htm">Set a descriptor record</A> (SQLSetDescRec) sets all the attributes for a descriptor record.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnsstma.htm">Set a statement attribute</A> (SQLSetStmtAttr) sets an attribute of a specific statement handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnscono.htm">Set connection option</A> (SQLSetConnectOption) sets connection attributes for a particular connection.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnscurn.htm">Set cursor name</A> (SQLSetCursorName) associates a cursor name with the statement handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnsenva.htm">Set environment attribute</A> (SQLSetEnvAttr) sets an environment attribute for the current environment.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnspara.htm">Set parameter</A> (SQLSetParam) associates (binds) an application variable to a parameter marker in an SQL statement.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnsstmo.htm">Set statement option</A> (SQLSetStmtOption) sets an attribute of a specific statement handle.</li>
|
||
|
|
<li><A HREF="../cli/rzadpfnpopt.htm">Specify an input array for a parameter</A> (SQLParamOptions) provides the ability to set multiple values for each parameter set by SQLBindParameter().</li>
|
||
|
|
<li><A HREF="../cli/rzadpfntrans.htm">Transaction management</A> (SQLTransact) commits or rolls back the current transaction in the connection.</li>
|
||
|
|
</ul>
|
||
|
|
<!--***************API END PASTE***************-->
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> |
|
||
|
|
<a href= "file1.htm">Database and File APIs</a> |<a href=
|
||
|
|
"aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|