File: prguid22.htm

package info (click to toggle)
solid-doc 2.2-1
links: PTS
area: non-free
in suites: potato, slink
size: 3,436 kB
ctags: 11,371
sloc: makefile: 58; sh: 2
file content (2883 lines) | stat: -rw-r--r-- 101,187 bytes
parent folder | download | duplicates (2)
<HTML>
<HEAD>
<TITLE>prguide.htm</TITLE>
<LINK REL="ToC" HREF="httoc.htm">
<LINK REL="Index" HREF="htindex.htm">
<LINK REL="Next" HREF="prguid23.htm">
<LINK REL="Previous" HREF="prguid21.htm"></HEAD>
<BODY BGCOLOR="#FFFFFF">
<P ALIGN=CENTER>
<A HREF="prguid21.htm" TARGET="_self"><IMG SRC="graprev.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Previous Page"></A>
<A HREF="httoc.htm" TARGET="_self"><IMG SRC="gratoc.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="TOC"></A>
<A HREF="htindex.htm" TARGET="_self"><IMG SRC="graindex.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Index"></A>
<A HREF="prguid23.htm" TARGET="_self"><IMG SRC="granext.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Next Page"></A>
<HR ALIGN=CENTER>
<P>
<UL>
<UL>
<LI>
<A HREF="#E74E9" >SQLPrepare (ODBC 1.0, Core)</A>
<UL>
<LI>
<A HREF="#E11E273" >Syntax</A>
<LI>
<A HREF="#E11E274" >Returns</A>
<LI>
<A HREF="#E11E275" >Diagnostics</A>
<LI>
<A HREF="#E11E276" >Comments</A>
<LI>
<A HREF="#E11E277" >Code Example</A>
<LI>
<A HREF="#E11E278" >Related Functions</A></UL>
<LI>
<A HREF="#E10E96" >SQLPrimaryKeys (ODBC 1.0, Level 2)</A>
<UL>
<LI>
<A HREF="#E11E279" >Syntax</A>
<LI>
<A HREF="#E11E280" >Returns</A>
<LI>
<A HREF="#E11E281" >Diagnostics</A>
<LI>
<A HREF="#E11E282" >Comments</A>
<LI>
<A HREF="#E11E283" >Code Example</A>
<LI>
<A HREF="#E11E284" >Related Functions</A></UL>
<LI>
<A HREF="#E10E97" >SQLProcedureColumns (ODBC 1.0, Level 2)</A>
<UL>
<LI>
<A HREF="#E11E285" >Syntax</A>
<LI>
<A HREF="#E11E286" >Returns</A>
<LI>
<A HREF="#E11E287" >Diagnostics</A>
<LI>
<A HREF="#E11E288" >Comments</A>
<LI>
<A HREF="#E11E289" >Code Example</A>
<LI>
<A HREF="#E11E290" >Related Functions</A></UL>
<LI>
<A HREF="#E10E98" >SQLProcedures (ODBC 1.0, Level 2)</A>
<UL>
<LI>
<A HREF="#E11E291" >Syntax</A>
<LI>
<A HREF="#E11E292" >Returns</A>
<LI>
<A HREF="#E11E293" >Diagnostics</A>
<LI>
<A HREF="#E11E294" >Comments</A>
<LI>
<A HREF="#E11E295" >Code Example</A>
<LI>
<A HREF="#E11E296" >Related Functions</A></UL>
<LI>
<A HREF="#E10E99" >SQLPutData (ODBC 1.0, Level 1)</A>
<UL>
<LI>
<A HREF="#E11E297" >Syntax</A>
<LI>
<A HREF="#E11E298" >Returns</A>
<LI>
<A HREF="#E11E299" >Diagnostics</A>
<LI>
<A HREF="#E11E300" >Comments</A>
<LI>
<A HREF="#E11E301" >Code Example</A>
<LI>
<A HREF="#E11E302" >Related Functions</A></UL></UL></UL>
<HR ALIGN=CENTER>
<A NAME="E74E9"></A>
<H2>
<FONT FACE="Arial"><B>SQLPrepare</B><B> (ODBC 1.0, Core)</B><A NAME="I2"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLPrepare</B> prepares an SQL string for execution.
</BLOCKQUOTE>
<A NAME="E11E273"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLPrepare</B>(<I>hstmt</I>, <I>szSqlStr</I>, <I>cbSqlStr</I>)<A NAME="I3"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLPrepare</B> function accepts the following arguments.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P><B>Type</B>
</BLOCKQUOTE></TD>
<TD WIDTH=80 VALIGN=top >
<A NAME="E7E1407"></A>
<P>Argument
</TD><TD WIDTH=80 VALIGN=top >
<A NAME="E7E1407"></A>
<P>Use
</TD><TD WIDTH=199 VALIGN=top >
<A NAME="E7E1407"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=80 VALIGN=top >
<A NAME="E7E1408"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=80 VALIGN=top >
<A NAME="E7E1408"></A>
<P>Input
</TD><TD WIDTH=199 VALIGN=top >
<A NAME="E7E1408"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=80 VALIGN=top >
<A NAME="E7E1409"></A>
<P><I>szSqlStr</I>
</TD><TD WIDTH=80 VALIGN=top >
<A NAME="E7E1409"></A>
<P>Input
</TD><TD WIDTH=199 VALIGN=top >
<A NAME="E7E1409"></A>
<P>SQL text string.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>SDWORD
</BLOCKQUOTE></TD>
<TD WIDTH=80 VALIGN=top >
<A NAME="E7E1410"></A>
<P><I>cbSqlStr</I>
</TD><TD WIDTH=80 VALIGN=top >
<A NAME="E7E1410"></A>
<P>Input
</TD><TD WIDTH=199 VALIGN=top >
<A NAME="E7E1410"></A>
<P>Length of <I>szSqlStr</I>.</TD></TR></TABLE>
<A NAME="E11E274"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I4"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E275"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I5"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLPrepare</B> returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, an associated SQLSTATE value may be obtained by calling <B>SQLError</B>. The following table lists the SQLSTATE values commonly returned by <B>SQLPrepare </B>and explains each one in the context of this function; the notation &quot;(DM)&quot; precedes the descriptions of SQLSTATEs returned by the Driver Manager. The return code associated with each SQLSTATE value is SQL_ERROR, unless noted otherwise.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P><B>SQLSTATE</B>
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1411"></A>
<P>Error
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1411"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1412"></A>
<P>General warning
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1412"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>08S01
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1413"></A>
<P>Communication link failure
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1413"></A>
<P>The communication link between the driver and the data source to which the driver was connected failed before the function completed processing.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>21S01
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1414"></A>
<P>Insert value list does not match column list
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1414"></A>
<P>The argument <I>szSqlStr</I> contained an <B>INSERT</B> statement and the number of values to be inserted did not match the degree of the derived table.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>21S02
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1415"></A>
<P>Degree of derived table does not match column list
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1415"></A>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE VIEW</B> statement and the number of names specified is not the same degree as the derived table defined by the query specification.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>22005
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1416"></A>
<P>Error in assignment
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1416"></A>
<P>The argument <I>szSqlStr</I> contained an SQL statement that contained a literal or parameter and the value was incompatible with the data type of the associated table column.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>24000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1417"></A>
<P>Invalid cursor state
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1417"></A>
<P>(DM) A cursor was open on the <I>hstmt</I> and <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had been called.
<BLOCKQUOTE>
<P>A cursor was open on the <I>hstmt</I> but <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had not been called.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>34000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1418"></A>
<P>Invalid cursor name
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1418"></A>
<P>The argument <I>szSqlStr</I> contained a positioned <B>DELETE</B> or a positioned <B>UPDATE</B> and the cursor referenced by the statement being prepared was not open.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>37000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1419"></A>
<P>Syntax error or access violation
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1419"></A>
<P>The argument <I>szSqlStr</I> contained an SQL statement that was not preparable or contained a syntax error.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>42000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1420"></A>
<P>Syntax error or access violation
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1420"></A>
<P>The argument <I>szSqlStr</I> contained a statement for which the user did not have the required privileges.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1421"></A>
<P>Driver does not support this function
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1421"></A>
<P>(DM) The driver associated with the <I>hstmt</I> does not support the function.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S0001
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1422"></A>
<P>Base table or view already exists
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1422"></A>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE TABLE</B> or <B>CREATE VIEW</B> statement and the table name or view name specified already exists.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S0002
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1423"></A>
<P>Base table not found
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1423"></A>
<P>The argument <I>szSqlStr</I> contained a <B>DROP TABLE</B> or a <B>DROP VIEW</B> statement and the specified table name or view name did not exist.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained an <B>ALTER TABLE</B> statement and the specified table name did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE VIEW</B> statement and a table name or view name defined by the query specification did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE INDEX</B> statement and the specified table name did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>GRANT</B> or <B>REVOKE</B> statement and the specified table name or view name did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>SELECT</B> statement and a specified table name or view name did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>DELETE</B>, <B>INSERT</B>, or <B>UPDATE</B> statement and the specified table name did not exist.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE TABLE</B> statement and a table specified in a constraint (referencing a table other than the one being created) did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S0011
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1424"></A>
<P>Index already exists
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1424"></A>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE INDEX</B> statement and the specified index name already existed.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S0012
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1425"></A>
<P>Index not found
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1425"></A>
<P>The argument <I>szSqlStr</I> contained a <B>DROP INDEX</B> statement and the specified index name did not exist.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S0021
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1426"></A>
<P>Column already exists
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1426"></A>
<P>The argument <I>szSqlStr</I> contained an <B>ALTER TABLE</B> statement and the column specified in the <B>ADD</B> clause is not unique or identifies an existing column in the base table.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S0022
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1427"></A>
<P>Column not found
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1427"></A>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE INDEX</B> statement and one or more of the column names specified in the column list did not exist.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>GRANT</B> or <B>REVOKE</B> statement and a specified column name did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=233 VALIGN=top >
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>SELECT</B>, <B>DELETE</B>, <B>INSERT</B>, or <B>UPDATE</B> statement and a specified column name did not exist.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The argument <I>szSqlStr</I> contained a <B>CREATE TABLE</B> statement and a column specified in a constraint (referencing a table other than the one being created) did not exist.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1428"></A>
<P>General error
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1428"></A>
<P>An error occurred for which there was no specific SQLSTATE and for which no implementation-specific SQLSTATE was defined. The error message returned by <B>SQLError</B> in the argument <I>szErrorMsg</I> describes the error and its cause.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1001
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1429"></A>
<P>Memory allocation failure
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1429"></A>
<P>The driver was unable to allocate memory required to support execution or completion of the function.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1008
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1430"></A>
<P>Operation canceled
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1430"></A>
<P>Asynchronous processing was enabled for the <I>hstmt</I>. The function was called and before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I>. Then the function was called again on the <I>hstmt</I>.
<BLOCKQUOTE>
<P>The function was called and, before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I> from a different thread in a multithreaded application.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1009
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1431"></A>
<P>Invalid argument value
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1431"></A>
<P>(DM) The argument <I>szSqlStr</I> was a null pointer.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1010
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1432"></A>
<P>Function sequence error
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1432"></A>
<P>(DM) An asynchronously executing function (not this one) was called for the <I>hstmt</I> and was still executing when this function was called.
<BLOCKQUOTE>
<P>(DM) <B>SQLExecute</B>, <B>SQLExecDirect</B>, or <B>SQLSetPos</B> was called for the <I>hstmt</I> and returned SQL_NEED_DATA. This function was called before data was sent for all data-at-execution parameters or columns.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1090
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1433"></A>
<P>Invalid string or buffer length
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1433"></A>
<P>(DM) The argument <I>cbSqlStr</I> was less than or equal to 0, but not equal to SQL_NTS. </TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1434"></A>
<P>Timeout expired
</TD><TD WIDTH=233 VALIGN=top >
<A NAME="E7E1434"></A>
<P>The timeout period expired before the data source returned the result set. The timeout period is set through <B>SQLSetStmtOption</B>, SQL_QUERY_TIMEOUT.</TD></TR></TABLE>
<A NAME="E11E276"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I6"></A><A NAME="I7"></A><A NAME="I8"></A><A NAME="I9"></A><A NAME="I10"></A><A NAME="I11"></A><A NAME="I12"></A><A NAME="I13"></A><A NAME="I14"></A></FONT></H3>
<BLOCKQUOTE>
<P>The application calls <B>SQLPrepare</B> to send an SQL statement to the data source for preparation. The application can include one or more parameter markers in the SQL statement. To include a parameter marker, the application embeds a question mark (?) into the SQL string at the appropriate position.<A NAME="I15"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note If an application uses <B>SQLPrepare</B> to prepare and <B>SQLExecute</B> to submit a <B>COMMIT</B> or <B>ROLLBACK</B> statement, it will not be interoperable between DBMS products. To commit or roll back a transaction, call <B>SQLTransact</B>.<A NAME="I16"></A></NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The driver modifies the statement to use the form of SQL used by the data source, then submits it to the data source for preparation. In particular, the driver modifies the escape clauses used to define ODBC-specific SQL. (For a description of SQL statement grammar, see Appendix C, &quot;SQL Grammar.&quot;) For the driver, an <I>hstmt</I> is similar to a statement identifier in embedded SQL code. If the data source supports statement identifiers, the driver can send a statement identifier and parameter values to the data source.<A NAME="I17"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>Once a statement is prepared, the application uses <I>hstmt</I> to refer to the statement in later function calls. The prepared statement associated with the <I>hstmt</I> may be reexecuted by calling <B>SQLExecute</B> until the application frees the <I>hstmt</I> with a call to <B>SQLFreeStmt</B> with the SQL_DROP option or until the <I>hstmt</I> is used in a call to <B>SQLPrepare</B>, <B>SQLExecDirect</B>, or one of the catalog functions (<B>SQLColumns</B>, <B>SQLTables</B>, and so on). Once the application prepares a statement, it can request information about the format of the result set.<A NAME="I18"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>Some drivers cannot return syntax errors or access violations when the application calls <B>SQLPrepare</B>. A driver may handle syntax errors and access violations, only syntax errors, or neither syntax errors nor access violations. Therefore, an application must be able to handle these conditions when calling subsequent related functions such as <B>SQLNumResultCols</B>, <B>SQLDescribeCol</B>, <B>SQLColAttributes</B>, and <B>SQLExecute</B>.<A NAME="I19"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>Depending on the capabilities of the driver and data source and on whether the application has called <B>SQLBindParameter</B>, parameter information (such as data types) might be checked when the statement is prepared or when it is executed. For maximum interoperability, an application should unbind all parameters that applied to an old SQL statement before preparing a new SQL statement on the same <I>hstmt</I>. This prevents errors that are due to old parameter information being applied to the new statement.<A NAME="I20"></A><A NAME="I21"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Important Committing or rolling back a transaction, either by calling <B>SQLTransact</B> or by using the SQL_AUTOCOMMIT connection option, can cause the data source to delete the access plans for all <I>hstmts</I> on an <I>hdbc</I>. For more information, see the SQL_CURSOR_COMMIT_BEHAVIOR and SQL_CURSOR_ROLLBACK_BEHAVIOR information types in <B>SQLGetInfo</B>.</NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<A NAME="E11E277"></A>
<H3>
<FONT FACE="Arial">Code Example<A NAME="I22"></A></FONT></H3>
<BLOCKQUOTE>
<P>See <B>SQLBindParameter</B>,<B> SQLParamOptions</B>, <B>SQLPutData</B>, and <B>SQLSetPos</B>.
</BLOCKQUOTE>
<A NAME="E11E278"></A>
<H3>
<FONT FACE="Arial">Related Functions</FONT></H3>

<TABLE WIDTH=800 >
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P><B>For information about</B>
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1435"></A>
<P>See</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Allocating a statement handle
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1436"></A>
<P><B>SQLAllocStmt</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a column in a result set
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1437"></A>
<P><B>SQLBindCol</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Canceling statement processing
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1438"></A>
<P><B>SQLCancel</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Executing an SQL statement
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1439"></A>
<P><B>SQLExecDirect</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Executing a prepared SQL statement
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1440"></A>
<P><B>SQLExecute</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Returning the number of rows affected by a statement
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1441"></A>
<P><B>SQLRowCount</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Setting a cursor name
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1442"></A>
<P><B>SQLSetCursorName</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a parameter
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1443"></A>
<P><B>SQLBindParameter</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Executing a commit or rollback operation
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1444"></A>
<P><B>SQLTransact</B></TD></TR></TABLE><A NAME="E7E1444"></A>
<A NAME="E10E96"></A>
<H2>
<FONT FACE="Arial"><B>SQL</B><B>PrimaryKeys</B><B> (ODBC 1.0, Level 2)</B><A NAME="I23"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLPrimaryKeys</B> returns the column names that comprise the primary key for a table. The driver returns the information as a result set. This function does not support returning primary keys from multiple tables in a single call.
</BLOCKQUOTE>
<A NAME="E11E279"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLPrimaryKeys</B>(<I>hstmt</I>, <I>szTableQualifier</I>, <I>cbTableQualifier</I>, <I>szTableOwner</I>, <I>cbTableOwner</I>, <I>szTableName</I>, <I>cbTableName</I>)<A NAME="I24"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLPrimaryKeys</B> function accepts the following arguments:
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P><B>Type</B>
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1445"></A>
<P>Argument
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1445"></A>
<P>Use
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1445"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1446"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1446"></A>
<P>Input
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1446"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1447"></A>
<P><I>szTableQualifie</I><I>r</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1447"></A>
<P>Input
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1447"></A>
<P>Qualifier name. If a driver supports qualifiers for some tables but not for others, such as when the driver retrieves data from different DBMSs, an empty string (&quot;&quot;) denotes those tables that do not have qualifiers.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1448"></A>
<P><I>cbTableQualifie</I><I>r</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1448"></A>
<P>Input
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1448"></A>
<P>Length of <I>szTableQualifier</I>.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1449"></A>
<P><I>szTableOwner</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1449"></A>
<P>Input
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1449"></A>
<P>Table owner. If a driver supports owners for some tables but not for others, such as when the driver retrieves data from different DBMSs, an empty string (&quot;&quot;) denotes those tables that do not have owners.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1450"></A>
<P><I>cbTableOwner</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1450"></A>
<P>Input
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1450"></A>
<P>Length of <I>szTableOwner.</I></TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1451"></A>
<P><I>szTableName</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1451"></A>
<P>Input
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1451"></A>
<P>Table name.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1452"></A>
<P><I>cbTableName</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1452"></A>
<P>Input
</TD><TD WIDTH=193 VALIGN=top >
<A NAME="E7E1452"></A>
<P>Length of <I>szTableName</I>.</TD></TR></TABLE>
<A NAME="E11E280"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I25"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E281"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I26"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLPrimaryKeys</B> returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, an associated SQLSTATE value may be obtained by calling <B>SQLError</B>. The following table lists the SQLSTATE values commonly returned by <B>SQLPrimaryKeys </B>and explains each one in the context of this function; the notation &quot;(DM)&quot; precedes the descriptions of SQLSTATEs returned by the Driver Manager. The return code associated with each SQLSTATE value is SQL_ERROR, unless noted otherwise.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P><B>SQLSTATE</B>
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1453"></A>
<P>Error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1453"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1454"></A>
<P>General warning
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1454"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>08S01
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1455"></A>
<P>Communication link failure
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1455"></A>
<P>The communication link between the driver and the data source to which the driver was connected failed before the function completed processing.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>24000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1456"></A>
<P>Invalid cursor state
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1456"></A>
<P>(DM) A cursor was open on the <I>hstmt</I> and <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had been called.
<BLOCKQUOTE>
<P>A cursor was open on the <I>hstmt</I> but <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had not been called.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1457"></A>
<P>Driver does not support this function
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1457"></A>
<P>(DM) The driver associated with the <I>hstmt</I> does not support the function.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1000
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1458"></A>
<P>General error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1458"></A>
<P>An error occurred for which there was no specific SQLSTATE and for which no implementation-specific SQLSTATE was defined. The error message returned by <B>SQLError</B> in the argument <I>szErrorMsg</I> describes the error and its cause.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1001
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1459"></A>
<P>Memory allocation failure
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1459"></A>
<P>The driver was unable to allocate memory required to support execution or completion of the function.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1008
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1460"></A>
<P>Operation canceled
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1460"></A>
<P>Asynchronous processing was enabled for the <I>hstmt</I>. The function was called and before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I>. Then the function was called again on the <I>hstmt</I>.
<BLOCKQUOTE>
<P>The function was called and, before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I> from a different thread in a multithreaded application.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1010
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1461"></A>
<P>Function sequence error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1461"></A>
<P>(DM) An asynchronously executing function (not this one) was called for the <I>hstmt</I> and was still executing when this function was called.
<BLOCKQUOTE>
<P>(DM) <B>SQLExecute</B>, <B>SQLExecDirect</B>, or <B>SQLSetPos</B> was called for the <I>hstmt</I> and returned SQL_NEED_DATA. This function was called before data was sent for all data-at-execution parameters or columns.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1090
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1462"></A>
<P>Invalid string or buffer length
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1462"></A>
<P>(DM) The value of one of the name length arguments was less than 0, but not equal to SQL_NTS.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=226 VALIGN=top >
<BLOCKQUOTE>
<P>The<B> </B>value of one of the name length arguments exceeded the maximum length value for the corresponding qualifier or name.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1C00
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1463"></A>
<P>Driver not capable
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1463"></A>
<P>A table qualifier was specified and the driver or data source does not support qualifiers.
<BLOCKQUOTE>
<P>A table owner was specified and the driver or data source does not support owners.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=100 VALIGN=top ><BR></TD>
<TD WIDTH=126 VALIGN=top ><BR></TD>
<TD WIDTH=226 VALIGN=top >
<BLOCKQUOTE>
<P>The combination of the current settings of the SQL_CONCURRENCY and SQL_CURSOR_TYPE statement options was not supported by the driver or data source.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=126 VALIGN=top >
<A NAME="E7E1464"></A>
<P>Timeout expired
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1464"></A>
<P>The timeout period expired before the data source returned the requested result set. The timeout period is set through <B>SQLSetStmtOption</B>, SQL_QUERY_TIMEOUT.</TD></TR></TABLE>
<A NAME="E11E282"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I27"></A><A NAME="I28"></A><A NAME="I29"></A><A NAME="I30"></A></FONT></H3>
<BLOCKQUOTE>
<P><B>SQLPrimaryKeys</B> returns the results as a standard result set, ordered by TABLE_QUALIFIER, TABLE_OWNER, TABLE_NAME, and KEY_SEQ. The following table lists the columns in the result set.<A NAME="I31"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note <B>SQLPrimaryKeys</B> might not return all primary keys. For example, a Paradox driver might only return primary keys for files (tables) in the current directory.<A NAME="I32"></A></NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The lengths of VARCHAR columns shown in the table are maximums; the actual lengths depend on the data source. To determine the actual lengths of the TABLE_QUALIFIER, TABLE_OWNER, TABLE_NAME, and COLUMN_NAME columns, call <B>SQLGetInfo</B> with the SQL_MAX_QUALIFIER_NAME_LEN, SQL_MAX_OWNER_NAME_LEN, SQL_MAX_TABLE_NAME_LEN, and SQL_MAX_COLUMN_NAME_LEN options.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=126 VALIGN=top >
<BLOCKQUOTE>
<P><B>Column Name</B>
</BLOCKQUOTE></TD>
<TD WIDTH=100 VALIGN=top >
<A NAME="E7E1465"></A>
<P>Data Type
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1465"></A>
<P>Comments</TD>
</TR>
<TR>
<TD WIDTH=126 VALIGN=top >
<BLOCKQUOTE>
<P>TABLE_QUALIFIER
</BLOCKQUOTE></TD>
<TD WIDTH=100 VALIGN=top >
<A NAME="E7E1466"></A>
<P>Varchar(128)
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1466"></A>
<P>Primary key table qualifier identifier; NULL if not applicable to the data source. If a driver supports qualifiers for some tables but not for others, such as when the driver retrieves data from different DBMSs, it returns an empty string (&quot;&quot;) for those tables that do not have qualifiers.</TD>
</TR>
<TR>
<TD WIDTH=126 VALIGN=top >
<BLOCKQUOTE>
<P>TABLE_OWNER
</BLOCKQUOTE></TD>
<TD WIDTH=100 VALIGN=top >
<A NAME="E7E1467"></A>
<P>Varchar(128)
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1467"></A>
<P>Primary key table owner identifier; NULL if not applicable to the data source. If a driver supports owners for some tables but not for others, such as when the driver retrieves data from different DBMSs, it returns an empty string (&quot;&quot;) for those tables that do not have owners.</TD>
</TR>
<TR>
<TD WIDTH=126 VALIGN=top >
<BLOCKQUOTE>
<P>TABLE_NAME
</BLOCKQUOTE></TD>
<TD WIDTH=100 VALIGN=top >
<A NAME="E7E1468"></A>
<P>Varchar(128)
<BR>not NULL
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1469"></A>
<P>Primary key table identifier.</TD>
</TR>
<TR>
<TD WIDTH=126 VALIGN=top >
<BLOCKQUOTE>
<P>COLUMN_NAME
</BLOCKQUOTE></TD>
<TD WIDTH=100 VALIGN=top >
<A NAME="E7E1470"></A>
<P>Varchar(128)
<BR>not NULL
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1471"></A>
<P>Primary key column identifier.</TD>
</TR>
<TR>
<TD WIDTH=126 VALIGN=top >
<BLOCKQUOTE>
<P>KEY_SEQ
</BLOCKQUOTE></TD>
<TD WIDTH=100 VALIGN=top >
<A NAME="E7E1472"></A>
<P>Smallint
<BR>not NULL
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1473"></A>
<P>Column sequence number in key (starting with 1).</TD>
</TR>
<TR>
<TD WIDTH=126 VALIGN=top >
<BLOCKQUOTE>
<P>PK_NAME
</BLOCKQUOTE></TD>
<TD WIDTH=100 VALIGN=top >
<A NAME="E7E1474"></A>
<P>Varchar(128)
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1474"></A>
<P>Primary key identifier. NULL if not applicable to the data source.</TD></TR></TABLE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note The PK_NAME column was added in ODBC 2.0. ODBC 1.0 drivers may return a different, driver-specific column with the same column number.</NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<A NAME="E11E283"></A>
<H3>
<FONT FACE="Arial">Code Example<A NAME="I33"></A></FONT></H3>
<BLOCKQUOTE>
<P>See <B>SQLForeignKeys</B>.
</BLOCKQUOTE>
<A NAME="E11E284"></A>
<H3>
<FONT FACE="Arial">Related Functions</FONT></H3>

<TABLE WIDTH=800 >
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P><B>For information about</B>
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1475"></A>
<P>See</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a column in a result set
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1476"></A>
<P><B>SQLBindCol</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Canceling statement processing
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1477"></A>
<P><B>SQLCancel</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a block of data or scrolling through a result set
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1478"></A>
<P><B>SQLExtendedFetch</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a row of data
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1479"></A>
<P><B>SQLFetch</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Returning the columns of foreign keys
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1480"></A>
<P><B>SQLForeignKeys</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Returning table statistics and indexes
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1481"></A>
<P><B>SQLStatistics</B> (extension)</TD></TR></TABLE><A NAME="E10E97"></A>
<H2>
<FONT FACE="Arial"><B>SQLProcedureColumns (ODBC 1.0, Level 2)</B><A NAME="I34"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLProcedureColumns</B> returns the list of input and output parameters, as well as the columns that make up the result set for the specified procedures. The driver returns the information as a result set on the specified <I>hstmt</I>.
</BLOCKQUOTE>
<A NAME="E11E285"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLProcedureColumns</B>(<I>hstmt</I>, <I>szProcQualifier</I>, <I>cbProcQualifier</I>, <I>szProcOwner</I>, <I>cbProcOwner</I>, <I>szProcName</I>, <I>cbProcName</I>, <I>szColumnName</I>, <I>cbColumnName</I>)<A NAME="I35"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLProcedureColumns</B> function accepts the following arguments:
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P><B>Type</B>
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1482"></A>
<P>Argument
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1482"></A>
<P>Use
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1482"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1483"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1483"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1483"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1484"></A>
<P><I>szProcQualifier</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1484"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1484"></A>
<P>Procedure qualifier name.  If a driver supports qualifiers for some procedures but not for others, such as when the driver retrieves data from different DBMSs, an empty string (&quot;&quot;) denotes those procedures that do not have qualifiers.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1485"></A>
<P><I>cbProcQualifier</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1485"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1485"></A>
<P>Length of <I>szProcQualifier</I>.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1486"></A>
<P><I>szProcOwner</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1486"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1486"></A>
<P>String search pattern for procedure owner names. If a driver supports owners for some procedures but not for others, such as when the driver retrieves data from different DBMSs, an empty string (&quot;&quot;) denotes those procedures that do not have owners.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1487"></A>
<P><I>cbProcOwner</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1487"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1487"></A>
<P>Length of <I>szProcOwner</I>.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1488"></A>
<P><I>szProcName</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1488"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1488"></A>
<P>String search pattern for procedure names.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1489"></A>
<P><I>cbProcName</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1489"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1489"></A>
<P>Length of <I>szProcName</I>.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1490"></A>
<P><I>szColumnName</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1490"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1490"></A>
<P>String search pattern for column names. </TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=93 VALIGN=top >
<A NAME="E7E1491"></A>
<P><I>cbColumnName</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1491"></A>
<P>Input
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1491"></A>
<P>Length of <I>szColumnName</I>.</TD></TR></TABLE>
<A NAME="E11E286"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I36"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E287"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I37"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLProcedureColumns</B> returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, an associated SQLSTATE value may be obtained by calling <B>SQLError</B>. The following table lists the SQLSTATE values commonly returned by <B>SQLProcedureColumns </B>and explains each one in the context of this function; the notation &quot;(DM)&quot; precedes the descriptions of SQLSTATEs returned by the Driver Manager. The return code associated with each SQLSTATE value is SQL_ERROR, unless noted otherwise.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P><B>SQLSTATE</B>
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1492"></A>
<P>Error
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1492"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1493"></A>
<P>General warning
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1493"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>08S01
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1494"></A>
<P>Communication link failure
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1494"></A>
<P>The communication link between the driver and the data source to which the driver was connected failed before the function completed processing.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>24000
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1495"></A>
<P>Invalid cursor state
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1495"></A>
<P>(DM) A cursor was open on the <I>hstmt</I> and <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had been called.
<BLOCKQUOTE>
<P>A cursor was open on the <I>hstmt</I> but <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had not been called.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1496"></A>
<P>Driver does not support this function
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1496"></A>
<P>(DM) The driver associated with the <I>hstmt</I> does not support the function.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1000
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1497"></A>
<P>General error
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1497"></A>
<P>An error occurred for which there was no specific SQLSTATE and for which no implementation-specific SQLSTATE was defined. The error message returned by <B>SQLError</B> in the argument <I>szErrorMsg</I> describes the error and its cause.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1001
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1498"></A>
<P>Memory allocation failure
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1498"></A>
<P>The driver was unable to allocate memory required to support execution or completion of the function.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1008
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1499"></A>
<P>Operation canceled
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1499"></A>
<P>Asynchronous processing was enabled for the <I>hstmt</I>. The function was called and before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I>. Then the function was called again on the <I>hstmt</I>.
<BLOCKQUOTE>
<P>The function was called and, before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I> from a different thread in a multithreaded application.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1010
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1500"></A>
<P>Function sequence error
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1500"></A>
<P>(DM) An asynchronously executing function (not this one) was called for the <I>hstmt</I> and was still executing when this function was called.
<BLOCKQUOTE>
<P>(DM) <B>SQLExecute</B>, <B>SQLExecDirect</B>, or <B>SQLSetPos</B> was called for the <I>hstmt</I> and returned SQL_NEED_DATA. This function was called before data was sent for all data-at-execution parameters or columns.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1090
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1501"></A>
<P>Invalid string or buffer length
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1501"></A>
<P>(DM) The value of one of the name length arguments was less than 0, but not equal to SQL_NTS.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=160 VALIGN=top ><BR></TD>
<TD WIDTH=196 VALIGN=top >
<BLOCKQUOTE>
<P>The value of one of the name length arguments exceeded the maximum length value for the corresponding qualifier or name.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1C00
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1502"></A>
<P>Driver not capable
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1502"></A>
<P>A procedure qualifier was specified and the driver or data source does not support qualifiers.
<BLOCKQUOTE>
<P>A procedure owner was specified and the driver or data source does not support owners.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=160 VALIGN=top ><BR></TD>
<TD WIDTH=196 VALIGN=top >
<BLOCKQUOTE>
<P>A string search pattern was specified for the procedure owner, procedure name, or column name and the data source does not support search patterns for one or more of those arguments.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The combination of the current settings of the SQL_CONCURRENCY and SQL_CURSOR_TYPE statement options was not supported by the driver or data source.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=160 VALIGN=top >
<A NAME="E7E1503"></A>
<P>Timeout expired
</TD><TD WIDTH=196 VALIGN=top >
<A NAME="E7E1503"></A>
<P>The timeout period expired before the data source returned the result set. The timeout period is set through <B>SQLSetStmtOption</B>, SQL_QUERY_TIMEOUT.</TD></TR></TABLE>
<A NAME="E11E288"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I38"></A><A NAME="I39"></A><A NAME="I40"></A></FONT></H3>
<BLOCKQUOTE>
<P>This function is typically used before statement execution to retrieve information about procedure parameters and columns from the data source&#146;s catalog. For more information about stored procedures, see &quot;Using ODBC Extensions to SQL&quot; in Chapter 6, &quot;Executing SQL Statements.&quot;<A NAME="I41"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note <B>SQLProcedureColumns</B> might not return all columns used by a procedure. For example, a driver might only return information about the parameters used by a procedure and not the columns in a result set it generates.<A NAME="I42"></A></NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <I>szProcOwner</I>, <I>szProcName</I>, and <I>szColumnName</I> arguments accept search patterns. For more information about valid search patterns, see &quot;Search Pattern Arguments&quot; earlier in this chapter.<A NAME="I43"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLProcedureColumns</B> returns the results as a standard result set, ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER, PROCEDURE_NAME, and COLUMN_TYPE. The following table lists the columns in the result set. Additional columns beyond column 13 (REMARKS) can be defined by the driver.<A NAME="I44"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The lengths of VARCHAR columns shown in the table are maximums; the actual lengths depend on the data source. To determine the actual lengths of the PROCEDURE_QUALIFIER, PROCEDURE_OWNER, PROCEDURE_NAME, and COLUMN_NAME columns, an application can call <B>SQLGetInfo</B> with the SQL_MAX_QUALIFIER_NAME_LEN, SQL_MAX_OWNER_NAME_LEN, SQL_MAX_PROCEDURE_NAME_LEN, and SQL_MAX_COLUMN_NAME_LEN options.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P><B>Column Name</B>
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1504"></A>
<P>Data Type
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1504"></A>
<P>Comments</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PROCEDURE_QUALIFIER
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1505"></A>
<P>Varchar(128)
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1505"></A>
<P>Procedure qualifier identifier; NULL if not applicable to the data source. If a driver supports qualifiers for some procedures but not for others, such as when the driver retrieves data from different DBMSs, it returns an empty string (&quot;&quot;) for those procedures that do not have qualifiers.<A NAME="I45"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PROCEDURE_OWNER
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1506"></A>
<P>Varchar(128)
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1506"></A>
<P>Procedure owner identifier; NULL if not applicable to the data source. If a driver supports owners for some procedures but not for others, such as when the driver retrieves data from different DBMSs, it returns an empty string (&quot;&quot;) for those procedures that do not have owners.<A NAME="I46"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PROCEDURE_NAME
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1507"></A>
<P>Varchar(128)
<BR>not NULL
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1508"></A>
<P>Procedure identifier.<A NAME="I47"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>COLUMN_NAME
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1509"></A>
<P>Varchar(128)
<BR>not NULL
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1510"></A>
<P>Procedure column identifier.<A NAME="I48"></A><A NAME="I49"></A><A NAME="I50"></A><A NAME="I51"></A><A NAME="I52"></A><A NAME="I53"></A><A NAME="I54"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>COLUMN_TYPE
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1511"></A>
<P>Smallint
<BR>not NULL
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1512"></A>
<P>Defines the procedure column as parameter or a result set column:
<BLOCKQUOTE>
<P>SQL_PARAM_TYPE_UNKNOWN: The procedure column is a parameter whose type is unknown. (ODBC 1.0)
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_PARAM_INPUT: The procedure column is an input parameter. (ODBC 1.0)
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_PARAM_INPUT_OUTPUT: the procedure column is an input/output parameter. (ODBC 1.0)
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_PARAM_OUTPUT: The procedure column is an output parameter. (ODBC 1.0)
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_RETURN_VALUE: The procedure column is the return value of the procedure. (ODBC 2.0)
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_RESULT_COL: The procedure column is a result set column. (ODBC 1.0)</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>DATA_TYPE
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1513"></A>
<P>Smallint
<BR>not NULL
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1514"></A>
<P>SQL data type. This can be an ODBC SQL data type or a driver-specific SQL data type. For a list of valid ODBC SQL data types, see &quot;SQL Data Types&quot; in Appendix D, &quot;Data Types.&quot; For information about driver-specific SQL data types, see the driver&#146;s documentation.</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>TYPE_NAME
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1515"></A>
<P>Varchar(128)
<BR>not NULL
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1516"></A>
<P>Data source&#150;dependent data type name; for example, &quot;CHAR&quot;, &quot;VARCHAR&quot;, &quot;MONEY&quot;, &quot;LONG VARBINARY&quot;, or &quot;CHAR ( ) FOR BIT DATA&quot;.</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PRECISION
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1517"></A>
<P>Integer
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1517"></A>
<P>The precision of the procedure column on the data source. NULL is returned for data types where precision is not applicable. For more information concerning precision, see &quot;Precision, Scale, Length, and Display Size,&quot; in Appendix D, &quot;Data Types.&quot;</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>LENGTH
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1518"></A>
<P>Integer
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1518"></A>
<P>The length in bytes of data transferred on an <B>SQLGetData</B> or <B>SQLFetch</B> operation if SQL_C_DEFAULT is specified. For numeric data, this size may be different than the size of the data stored on the data source. For more information, see &quot;Precision, Scale, Length, and Display Size,&quot; in Appendix D, &quot;Data Types.&quot;</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>SCALE
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1519"></A>
<P>Smallint
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1519"></A>
<P>The scale of the procedure column on the data source. NULL is returned for data types where scale is not applicable. For more information concerning scale, see &quot;Precision, Scale, Length, and Display Size,&quot; in Appendix D, &quot;Data Types.&quot;<A NAME="I55"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>RADIX
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1520"></A>
<P>Smallint
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1520"></A>
<P>For numeric data types, either 10 or 2. If it is 10, the values in PRECISION and SCALE give the number of decimal digits allowed for the column. For example, a DECIMAL(12,5) column would return a RADIX of 10, a PRECISION of 12, and a SCALE of 5; a FLOAT column could return a RADIX of 10, a PRECISION of 15 and a SCALE of NULL.
<BLOCKQUOTE>
<P>If it is 2, the values in PRECISION and SCALE give the number of bits allowed in the column. For example, a FLOAT column could return a RADIX of 2, a PRECISION of 53, and a SCALE of NULL.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>NULL is returned for data types where radix is not applicable. </TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>NULLABLE
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1521"></A>
<P>Smallint
<BR>not NULL
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1522"></A>
<P>Whether the procedure column accepts a NULL value:
<BLOCKQUOTE>
<P>SQL_NO_NULLS: The procedure column does not accept NULL values.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_NULLABLE: The procedure column accepts NULL values.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_NULLABLE_UNKNOWN: It is not known if the procedure column accepts NULL values.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>REMARKS
</BLOCKQUOTE></TD>
<TD WIDTH=92 VALIGN=top >
<A NAME="E7E1523"></A>
<P>Varchar(254)
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1523"></A>
<P>A description of the procedure column.</TD></TR></TABLE>
<A NAME="E11E289"></A>
<H3>
<FONT FACE="Arial">Code Example<A NAME="I56"></A></FONT></H3>
<BLOCKQUOTE>
<P>See <B>SQLProcedures</B>.
</BLOCKQUOTE>
<A NAME="E11E290"></A>
<H3>
<FONT FACE="Arial">Related Functions</FONT></H3>

<TABLE WIDTH=800 >
<TR>
<TD WIDTH=260 VALIGN=top >
<BLOCKQUOTE>
<P><B>For information about</B>
</BLOCKQUOTE></TD>
<TD WIDTH=186 VALIGN=top >
<A NAME="E7E1524"></A>
<P><B>See</B></TD>
</TR>
<TR>
<TD WIDTH=260 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a column in a result set
</BLOCKQUOTE></TD>
<TD WIDTH=186 VALIGN=top >
<A NAME="E7E1525"></A>
<P><B>SQLBindCol</B></TD>
</TR>
<TR>
<TD WIDTH=260 VALIGN=top >
<BLOCKQUOTE>
<P>Canceling statement processing
</BLOCKQUOTE></TD>
<TD WIDTH=186 VALIGN=top >
<A NAME="E7E1526"></A>
<P><B>SQLCancel</B></TD>
</TR>
<TR>
<TD WIDTH=260 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a block of data or scrolling through a result set
</BLOCKQUOTE></TD>
<TD WIDTH=186 VALIGN=top >
<A NAME="E7E1527"></A>
<P><B>SQLExtendedFetch</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=260 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a row of data
</BLOCKQUOTE></TD>
<TD WIDTH=186 VALIGN=top >
<A NAME="E7E1528"></A>
<P><B>SQLFetch</B></TD>
</TR>
<TR>
<TD WIDTH=260 VALIGN=top >
<BLOCKQUOTE>
<P>Returning a list of procedures in a data source
</BLOCKQUOTE></TD>
<TD WIDTH=186 VALIGN=top >
<A NAME="E7E1529"></A>
<P><B>SQLProcedures</B> (extension)</TD></TR></TABLE><A NAME="E10E98"></A>
<H2>
<FONT FACE="Arial"><B>SQLProcedures (ODBC 1.0, Level 2)</B><A NAME="I57"></A><A NAME="I58"></A><A NAME="I59"></A><A NAME="I60"></A><A NAME="I61"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLProcedures</B> returns the list of procedure names stored in a specific data source. <I>Procedure</I> is a generic term used to describe an <I>executable object</I>, or a named entity that can be invoked using input and output parameters, and which can return result sets similar to the results returned by SQL <B>SELECT</B> expressions.
</BLOCKQUOTE>
<A NAME="E11E291"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLProcedures</B>(<I>hstmt</I>, <I>szProcQualifier</I>, <I>cbProcQualifier</I>, <I>szProcOwner</I>, <I>cbProcOwner</I>, <I>szProcName</I>, <I>cbProcName</I>)<A NAME="I62"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLProcedures</B> function accepts the following arguments:
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P><B>Type</B>
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1530"></A>
<P><B>Argument</B>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1530"></A>
<P><B>Use</B>
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1530"></A>
<P><B>Description</B></TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1531"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1531"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1531"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1532"></A>
<P><I>szProcQualifier</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1532"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1532"></A>
<P>Procedure qualifier. If a driver supports qualifiers for some tables but not for others, such as when the driver retrieves data from different DBMSs, an empty string (&quot;&quot;) denotes those tables that do not have qualifiers.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1533"></A>
<P><I>cbProcQualifier</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1533"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1533"></A>
<P>Length of <I>szProcQualifier</I>.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1534"></A>
<P><I>szProcOwner</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1534"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1534"></A>
<P>String search pattern for procedure owner names. If a driver supports owners for some procedures but not for others, such as when the driver retrieves data from different DBMSs, an empty string (&quot;&quot;) denotes those procedures that do not have owners.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1535"></A>
<P><I>cbProcOwner</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1535"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1535"></A>
<P>Length of <I>szProcOwner</I>.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1536"></A>
<P><I>szProcName</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1536"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1536"></A>
<P>String search pattern for procedure names.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1537"></A>
<P><I>cbProcName</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1537"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1537"></A>
<P>Length of <I>szProcName</I>.</TD></TR></TABLE>
<A NAME="E11E292"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I63"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E293"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I64"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLProcedures</B> returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, an associated SQLSTATE value may be obtained by calling <B>SQLError</B>. The following table lists the SQLSTATE values commonly returned by <B>SQLProcedures </B>and explains each one in the context of this function; the notation &quot;(DM)&quot; precedes the descriptions of SQLSTATEs returned by the Driver Manager. The return code associated with each SQLSTATE value is SQL_ERROR, unless noted otherwise.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P><B>SQLSTATE</B>
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1538"></A>
<P>Error
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1538"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1539"></A>
<P>General warning
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1539"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>08S01
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1540"></A>
<P>Communication link failure
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1540"></A>
<P>The communication link between the driver and the data source to which the driver was connected failed before the function completed processing.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>24000
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1541"></A>
<P>Invalid cursor state
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1541"></A>
<P>(DM) A cursor was open on the <I>hstmt</I> and <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had been called.
<BLOCKQUOTE>
<P>A cursor was open on the <I>hstmt</I> but <B>SQLFetch</B> or <B>SQLExtendedFetch</B> had not been called.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1542"></A>
<P>Driver does not support this function
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1542"></A>
<P>(DM) The driver associated with the <I>hstmt</I> does not support this function.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1000
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1543"></A>
<P>General error
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1543"></A>
<P>An error occurred for which there was no specific SQLSTATE and for which no implementation-specific SQLSTATE was defined. The error message returned by <B>SQLError</B> in the argument <I>szErrorMsg</I> describes the error and its cause.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1001
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1544"></A>
<P>Memory allocation failure
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1544"></A>
<P>The driver was unable to allocate memory required to support execution or completion of the function.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1008
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1545"></A>
<P>Operation canceled
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1545"></A>
<P>Asynchronous processing was enabled for the <I>hstmt</I>. The function was called and before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I>. Then the function was called again on the <I>hstmt</I>.
<BLOCKQUOTE>
<P>The function was called and, before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I> from a different thread in a multithreaded application.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1010
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1546"></A>
<P>Function sequence error
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1546"></A>
<P>(DM) An asynchronously executing function (not this one) was called for the <I>hstmt</I> and was still executing when this function was called.
<BLOCKQUOTE>
<P>(DM) <B>SQLExecute</B>, <B>SQLExecDirect</B>, or <B>SQLSetPos</B> was called for the <I>hstmt</I> and returned SQL_NEED_DATA. This function was called before data was sent for all data-at-execution parameters or columns.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1090
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1547"></A>
<P>Invalid string or buffer length
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1547"></A>
<P>(DM) The value of one of the name length arguments was less than 0, but not equal to SQL_NTS.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=153 VALIGN=top ><BR></TD>
<TD WIDTH=206 VALIGN=top >
<BLOCKQUOTE>
<P>The<B> </B>value of one of the name length argu-ments exceeded the maximum length value for the corresponding qualifier or name. </TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1C00
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1548"></A>
<P>Driver not capable
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1548"></A>
<P>A procedure qualifier was specified and the driver or data source does not support qualifiers.
<BLOCKQUOTE>
<P>A procedure owner was specified and the driver or data source does not support owners.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top ><BR></TD>
<TD WIDTH=153 VALIGN=top ><BR></TD>
<TD WIDTH=206 VALIGN=top >
<BLOCKQUOTE>
<P>A string search pattern was specified for the procedure owner or procedure name and the data source does not support search patterns for one or more of those arguments.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The combination of the current settings of the SQL_CONCURRENCY and SQL_CURSOR_TYPE statement options was not supported by the driver or data source.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=153 VALIGN=top >
<A NAME="E7E1549"></A>
<P>Timeout expired
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1549"></A>
<P>The timeout period expired before the data source returned the requested result set. The timeout period is set through <B>SQLSetStmtOption</B>, SQL_QUERY_TIMEOUT.</TD></TR></TABLE>
<A NAME="E11E294"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I65"></A></FONT></H3>
<BLOCKQUOTE>
<P><B>SQLProcedures</B> lists all procedures in the requested range. A user may or may not have permission to execute any of these procedures. To check accessibility, an application can call <B>SQLGetInfo</B> and check the SQL_ACCESSIBLE_PROCEDURES information value. Otherwise, the application must be able to handle a situation where the user selects a procedure which it cannot execute.<A NAME="I66"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note <B>SQLProcedures</B> might not return all procedures. Applications can use any valid procedure, regardless of whether it is returned by <B>SQLProcedures</B>.<A NAME="I67"></A></NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLProcedures</B> returns the results as a standard result set, ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER, and PROCEDURE_NAME. The following table lists the columns in the result set.<A NAME="I68"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The lengths of VARCHAR columns shown in the table are maximums; the actual lengths depend on the data source. To determine the actual lengths of the PROCEDURE_QUALIFIER, PROCEDURE_OWNER, and PROCEDURE_NAME columns, an application can call <B>SQLGetInfo</B> with the SQL_MAX_QUALIFIER_NAME_LEN, SQL_MAX_OWNER_NAME_LEN, and SQL_MAX_PROCEDURE_NAME_LEN options.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P><B>Column Name</B>
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1550"></A>
<P>Data Type
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1550"></A>
<P>Comments</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PROCEDURE_QUALIFIER
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1551"></A>
<P>Varchar(128)
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1551"></A>
<P>Procedure qualifier identifier; NULL if not applicable to the data source. If a driver supports qualifiers for some procedures but not for others, such as when the driver retrieves data from different DBMSs, it returns an empty string (&quot;&quot;) for those procedures that do not have qualifiers.<A NAME="I69"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PROCEDURE_OWNER
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1552"></A>
<P>Varchar(128)
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1552"></A>
<P>Procedure owner identifier; NULL if not applicable to the data source. If a driver supports owners for some procedures but not for others, such as when the driver retrieves data from different DBMSs, it returns an empty string (&quot;&quot;) for those procedures that do not have owners.<A NAME="I70"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PROCEDURE_NAME
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1553"></A>
<P>Varchar(128)
<BR>not NULL
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1554"></A>
<P>Procedure identifier.</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>NUM_INPUT_PARAMS
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1555"></A>
<P>N/A
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1555"></A>
<P>Reserved for future use. Applications should not rely on the data returned in these result columns.</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>NUM_OUTPUT_PARAMS
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1556"></A>
<P>N/A
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1556"></A>
<P>Reserved for future use. Applications should not rely on the data returned in these result columns.</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>NUM_RESULT_SETS
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1557"></A>
<P>N/A
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1557"></A>
<P>Reserved for future use. Applications should not rely on the data returned in these result columns.</TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>REMARKS
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1558"></A>
<P>Varchar(254)
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1558"></A>
<P>A description of the procedure.<A NAME="I71"></A></TD>
</TR>
<TR>
<TD WIDTH=167 VALIGN=top >
<BLOCKQUOTE>
<P>PROCEDURE_TYPE
</BLOCKQUOTE></TD>
<TD WIDTH=79 VALIGN=top >
<A NAME="E7E1559"></A>
<P>Smallint
</TD><TD WIDTH=206 VALIGN=top >
<A NAME="E7E1559"></A>
<P>Defines the procedure type:
<BLOCKQUOTE>
<P>SQL_PT_UNKNOWN: It cannot be determined whether the procedure returns a value.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_PT_PROCEDURE: The returned object is a procedure; that is, it does not have a return value.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>SQL_PT_FUNCTION: The returned object is a function; that is, it has a return value.</TD></TR></BLOCKQUOTE></TABLE><A NAME="I72"></A>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note The PROCEDURE_TYPE column was added in ODBC 2.0. ODBC 1.0 drivers might return a different, driver-specific column with the same column number.<A NAME="I73"></A></NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <I>szProcOwner</I> and <I>szProcName</I> arguments accept search patterns. For more information about valid search patterns, see &quot;Search Pattern Arguments&quot; earlier in this chapter.
</BLOCKQUOTE>
<A NAME="E11E295"></A>
<H3>
<FONT FACE="Arial">Code Example<A NAME="I74"></A></FONT></H3>
<BLOCKQUOTE>
<P>In this example, an application uses the procedure <B>AddEmployee</B> to insert data into the EMPLOYEE table. The procedure contains input parameters for NAME, AGE, and BIRTHDAY columns. It also contains one output parameter that returns a remark about the new employee. The example also shows the use of a return value from a stored procedure. For the return value and each parameter in the procedure, the application calls <B>SQLBindParameter</B> to specify the ODBC C data type and the SQL data type of the parameter and to specify the storage location and length of the parameter. The application assigns data values to the storage locations for each parameter and calls <B>SQLExecDirect</B> to execute the procedure. If <B>SQLExecDirect</B> returns SQL_SUCCESS or SQL_SUCCESS_WITH_INFO, the return value and the value of each output or input/output parameter is automatically put into the storage location defined for the parameter in <B>SQLBindParameter</B>.
</BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
<FONT FACE="Courier New">#define NAME_LEN 30
#define REM_LEN 128
UCHAR       szName[NAME_LEN], szRemark[REM_LEN];
SWORD       sAge, sEmpId;
SDWORD      cbEmpId, cbName, cbAge = 0, cbBirthday = 0, cbRemark;
DATE_STRUCT dsBirthday;
/* Define parameter for return value (Employee ID) from procedure. */
SQLBindParameter(hstmt, 1, SQL_PARAM_OUTPUT, SQL_C_SLONG, SQL_INTEGER,
<BR>                 0, 0, &amp;sEmpId, 0, &amp;cbEmpId);
/* Define data types and storage locations for Name, Age, Birthday */
/* input parameter data.                                           */
SQLBindParameter(hstmt, 2, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR,
<BR>                 NAME_LEN, 0, szName, 0, &amp;cbName);
SQLBindParameter(hstmt, 3, SQL_PARAM_INPUT, SQL_C_SSHORT, SQL_SMALLINT,
<BR>                 0, 0, &amp;sAge, 0, &amp;cbAge);
SQLBindParameter(hstmt, 4, SQL_PARAM_INPUT, SQL_C_DATE, SQL_DATE,
<BR>                 0, 0, &amp;dsBirthday, 0, &amp;cbBirthday);
/* Define data types and storage location for Remark output parameter */
SQLBindParameter(hstmt, 5, SQL_PARAM_OUTPUT, SQL_C_CHAR, SQL_CHAR,
<BR>                 REM_LEN, 0, szRemark, REM_LEN, &amp;cbRemark);
strcpy(szName, &quot;Smith, John D.&quot;);    /* Specify first row of */
sAge = 40;                           /* parameter data.      */
dsBirthday.year = 1952;
dsBirthday.month = 2;
dsBirthday.day = 29;
cbName = SQL_NTS;
/* Execute procedure with first row of data. After the procedure */
/* is executed, sEmpId and szRemark will have the values         */
/* returned by AddEmployee.                                      */
retcode = SQLExecDirect(hstmt, &quot;{?=call AddEmployee(?,?,?,?)}&quot;,SQL_NTS);
strcpy(szName, &quot;Jones, Bob K.&quot;);     /* Specify second row of */
sAge = 52;                           /* parameter data        */
dsBirthday.year = 1940;
dsBirthday.month = 3;
dsBirthday.day = 31;
/* Execute procedure with second row of data. After the procedure */
/* is executed, sEmpId and szRemark will have the new values      */
/* returned by AddEmployee.                                       */
retcode = SQLExecDirect(hstmt,
<BR>                        &quot;{?=call AddEmployee(?,?,?,?)}&quot;, SQL_NTS);</FONT></PRE></BLOCKQUOTE>
<A NAME="E11E296"></A>
<H3>
<FONT FACE="Arial">Related Functions</FONT></H3>

<TABLE WIDTH=800 >
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P><B>For information about</B>
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1560"></A>
<P><B>See</B></TD>
</TR>
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a column in a result set
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1561"></A>
<P><B>SQLBindCol</B></TD>
</TR>
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P>Canceling statement processing
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1562"></A>
<P><B>SQLCancel</B></TD>
</TR>
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a block of data or scrolling through a result set
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1563"></A>
<P><B>SQLExtendedFetch</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a row of data
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1564"></A>
<P><B>SQLFetch</B></TD>
</TR>
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P>Returning information about a driver or data source
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1565"></A>
<P><B>SQLGetInfo</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P>Returning the parameters and result set columns of a procedure
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1566"></A>
<P><B>SQLProcedureColumns</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=246 VALIGN=top >
<BLOCKQUOTE>
<P>Syntax for invoking stored procedures
</BLOCKQUOTE></TD>
<TD WIDTH=206 VALIGN=top >
<A NAME="E7E1567"></A>
<P><B>Chapter 6</B>, &quot;Executing SQL Statements&quot;</TD></TR></TABLE><A NAME="E10E99"></A>
<H2>
<FONT FACE="Arial"><B>SQLPutData (ODBC 1.0, Level 1)</B><A NAME="I75"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLPutData</B> allows an application to send data for a parameter or column to the driver at statement execution time. This function can be used to send character or binary data values in parts to a column with a character, binary, or data source&#150;specific data type (for example, parameters of the SQL_LONGVARBINARY or SQL_LONGVARCHAR types).
</BLOCKQUOTE>
<A NAME="E11E297"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLPutData</B>(<I>hstmt</I>, <I>rgbValue</I>, <I>cbValue</I>)<A NAME="I76"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLPutData</B> function accepts the following arguments.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=73 VALIGN=top >
<BLOCKQUOTE>
<P><B>Type</B>
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1568"></A>
<P>Argument
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1568"></A>
<P>Use
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1568"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=73 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1569"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1569"></A>
<P>Input
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1569"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=73 VALIGN=top >
<BLOCKQUOTE>
<P>PTR
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1570"></A>
<P><I>rgbValue</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1570"></A>
<P>Input
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1570"></A>
<P>Pointer to storage for the actual data for the parameter or column. The data must use the C data type specified in the <I>fCType</I> argument of <B>SQLBindParameter</B> (for parameter data) or <B>SQLBindCol</B> (for column data).</TD>
</TR>
<TR>
<TD WIDTH=73 VALIGN=top >
<BLOCKQUOTE>
<P>SDWORD<A NAME="I77"></A>
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P><I>cbValue</I>
</BLOCKQUOTE></TD>
<TD WIDTH=73 VALIGN=top >
<A NAME="E7E1571"></A>
<P>Input
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1571"></A>
<P>Length of <I>rgbValue</I>. Specifies the amount of data sent in a call to <B>SQLPutData</B>. The amount of data can vary with each call for a given parameter or column. <I>cbValue</I> is ignored unless it is SQL_NTS, SQL_NULL_DATA, or SQL_DEFAULT_PARAM; the C data type specified in <B>SQLBindParameter</B> or <B>SQLBindCol</B> is SQL_C_CHAR or SQL_C_BINARY; or the C data type is SQL_C_DEFAULT and the default C data type for the specified SQL data type is SQL_C_CHAR or SQL_C_BINARY. For all other types of C data, if <I>cbValue</I> is not SQL_NULL_DATA or SQL_DEFAULT_PARAM, the driver assumes that the size of <I>rgbValue</I> is the size of the C data type specified with <I>fCType</I> and sends the entire data value. For more information, see &quot;Converting Data from C to SQL Data Types&quot; in Appendix D, &quot;Data Types.&quot;</TD></TR></TABLE>
<A NAME="E11E298"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I78"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E299"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I79"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLPutData</B> returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, an associated SQLSTATE value may be obtained by calling <B>SQLError</B>. The following table lists the SQLSTATE values commonly returned by <B>SQLPutData </B>and explains each one in the context of this function; the notation &quot;(DM)&quot; precedes the descriptions of SQLSTATEs returned by the Driver Manager. The return code associated with each SQLSTATE value is SQL_ERROR, unless noted otherwise.
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P><B>SQLSTATE</B>
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1572"></A>
<P>Error
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1572"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1573"></A>
<P>General warning
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1573"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>01004
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1574"></A>
<P>Data truncated
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1574"></A>
<P>The data sent for a character or binary parameter or column in one or more calls to <B>SQLPutData</B> exceeded the maximum length of the associated character or binary column.
<BLOCKQUOTE>
<P>The fractional part of the data sent for a numeric or bit parameter or column was truncated.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>Timestamp data sent for a date or time parameter or column was truncated.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>08S01
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1575"></A>
<P>Communication link failure
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1575"></A>
<P>The communication link between the driver and the data source to which the driver was connected failed before the function completed processing.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>22001
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1576"></A>
<P>String data right truncation
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1576"></A>
<P>The SQL_NEED_LONG_DATA_LEN information type in <B>SQLGetInfo</B> was &quot;Y&quot; and more data was sent for a long parameter (the data type was SQL_LONGVARCHAR, SQL_LONGVARBINARY, or a long, data source&#150;specific data type) than was specified with the <I>pcbValue</I> argument in <B>SQLBindParameter</B>.
<BLOCKQUOTE>
<P>The SQL_NEED_LONG_DATA_LEN information type in <B>SQLGetInfo</B> was &quot;Y&quot; and more data was sent for a long column (the data type was SQL_LONGVARCHAR, SQL_LONGVARBINARY, or a long, data source&#150;specific data type) than was specified in the length buffer corresponding to a column in a row of data that was added or updated with <B>SQLSetPos</B>.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>22003
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1577"></A>
<P>Numeric value out of range
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1577"></A>
<P><B>SQLPutData</B> was called more than once for a parameter or column and it was not being used to send character C data to a column with a character, binary, or data source&#150;specific data type or to send binary C data to a column with a character, binary, or data source&#150;specific data type.
<BLOCKQUOTE>
<P>The data sent for a numeric parameter or column caused the whole (as opposed to fractional) part of the number to be truncated when assigned to the associated table column.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>22005
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1578"></A>
<P>Error in assignment
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1578"></A>
<P>The data sent for a parameter or column was incompatible with the data type of the associated table column.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>22008
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1579"></A>
<P>Datetime field overflow
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1579"></A>
<P>The data sent for a date, time, or timestamp parameter or column was, respectively, an invalid date, time, or timestamp.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1580"></A>
<P>Driver does not support this function
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1580"></A>
<P>(DM) The driver associated with the <I>hstmt</I> does not support the function.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1000
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1581"></A>
<P>General error
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1581"></A>
<P>An error occurred for which there was no specific SQLSTATE and for which no implementation-specific SQLSTATE was defined. The error message returned by <B>SQLError</B> in the argument <I>szErrorMsg</I> describes the error and its cause.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1001
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1582"></A>
<P>Memory allocation failure
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1582"></A>
<P>The driver was unable to allocate memory required to support execution or completion of the function.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1008
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1583"></A>
<P>Operation canceled
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1583"></A>
<P>Asynchronous processing was enabled for the <I>hstmt</I>. The function was called and before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I>. Then the function was called again on the <I>hstmt</I>.
<BLOCKQUOTE>
<P>The function was called and, before it completed execution, <B>SQLCancel</B> was called on the <I>hstmt</I> from a different thread in a multithreaded application.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLExecute</B>, <B>SQLExecDirect</B>, or <B>SQLSetPos</B> was called for the <I>hstmt</I> and returned SQL_NEED_DATA. <B>SQLCancel</B> was called before data was sent for all data-at-execution parameters or columns.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1009
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1584"></A>
<P>Invalid argument value
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1584"></A>
<P>(DM) The argument <I>rgbValue</I> was a null pointer and the argument <I>cbValue</I> was not 0, SQL_DEFAULT_PARAM, or SQL_NULL_DATA.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1010
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1585"></A>
<P>Function sequence error
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1585"></A>
<P>(DM) The previous function call was not a call to <B>SQLPutData</B> or <B>SQLParamData</B>.
<BLOCKQUOTE>
<P>The previous function call was a call to <B>SQLExecDirect</B>, <B>SQLExecute</B>, or <B>SQLSetPos</B> where the return code was SQL_NEED_DATA.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=86 VALIGN=top ><BR></TD>
<TD WIDTH=166 VALIGN=top ><BR></TD>
<TD WIDTH=200 VALIGN=top >
<BLOCKQUOTE>
<P>(DM) An asynchronously executing function (not this one) was called for the <I>hstmt</I> and was still executing when this function was called.</TD>
</TR>
</BLOCKQUOTE>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1090
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1586"></A>
<P>Invalid string or buffer length
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1586"></A>
<P>The argument <I>rgbValue</I> was not a null pointer and the argument <I>cbValue</I> was less than 0, but not equal to SQL_NTS or SQL_NULL_DATA.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=166 VALIGN=top >
<A NAME="E7E1587"></A>
<P>Timeout expired
</TD><TD WIDTH=200 VALIGN=top >
<A NAME="E7E1587"></A>
<P>The timeout period expired before the data source completed processing the parameter value. The timeout period is set through <B>SQLSetStmtOption</B>, SQL_QUERY_TIMEOUT.</TD></TR></TABLE>
<A NAME="E11E300"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I80"></A></FONT></H3>
<BLOCKQUOTE>
<P>For an explanation of how data-at-execution parameter data is passed at statement execution time, see &quot;Passing Parameter Values&quot; in <B>SQLBindParameter</B>. For an explanation of how data-at-execution column data is updated or added, see &quot;Using SQLSetPos&quot; in <B>SQLSetPos</B>.<A NAME="I81"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note An application can use <B>SQLPutData</B> to send data in parts only when sending character C data to a column with a character, binary, or data source&#150;specific data type or when sending binary C data to a column with a character, binary, or data source&#150;specific data type. If <B>SQLPutData</B> is called more than once under any other conditions, it returns SQL_ERROR and SQLSTATE 22003 (Numeric value out of range).</NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE>
<A NAME="E11E301"></A>
<H3>
<FONT FACE="Arial">Code Example<A NAME="I82"></A></FONT></H3>
<BLOCKQUOTE>
<P>In the following example, an application prepares an SQL statement to insert data into the EMPLOYEE table. The statement contains parameters for the NAME, ID, and PHOTO columns. For each parameter, the application calls <B>SQLBindParameter</B> to specify the C and SQL data types of the parameter. It also specifies that the data for the first and third parameters will be passed at execution time, and passes the values 1 and 3 for later retrieval by <B>SQLParamData</B>. These values will identify which parameter is being processed.<A NAME="I83"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The application calls <B>GetNextID</B> to get the next available employee ID number. It then calls <B>SQLExecute</B> to execute the statement. <B>SQLExecute</B> returns SQL_NEED_DATA when it needs data for the first and third parameters. The application calls <B>SQLParamData</B> to retrieve the value it stored with <B>SQLBindParameter</B>; it uses this value to determine which parameter to send data for. For each parameter, the application calls <B>InitUserData</B> to initialize the data routine. It repeatedly calls <B>GetUserData</B> and <B>SQLPutData</B> to get and send the parameter data. Finally, it calls <B>SQLParamData</B> to indicate it has sent all the data for the parameter and to retrieve the value for the next parameter. After data has been sent for both parameters, <B>SQLParamData</B> returns SQL_SUCCESS.<A NAME="I84"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>For the first parameter, <B>InitUserData</B> does not do anything and <B>GetUserData</B> calls a routine to prompt the user for the employee name. For the third parameter, <B>InitUserData</B> calls a routine to prompt the user for the name of a file containing a bitmap photo of the employee and opens the file. <B>GetUserData</B> retrieves the next MAX_DATA_LEN bytes of photo data from the file. After it has retrieved all the photo data, it closes the photo file.<A NAME="I85"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>Note that some application routines are omitted for clarity.
</BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
<FONT FACE="Courier New">#define NAME_LEN 30
#define MAX_DATA_LEN 1024
SDWORD  cbNameParam, cbID = 0; cbPhotoParam, cbData;
SWORD   sID;
PTR     pToken, InitValue;
UCHAR   Data[MAX_DATA_LEN];
retcode = SQLPrepare(hstmt,
          &quot;INSERT INTO EMPLOYEE (NAME, ID, PHOTO) VALUES (?, ?, ?)&quot;,
          SQL_NTS);
if (retcode == SQL_SUCCESS) {
   /* Bind the parameters. For parameters 1 and 3, pass the       */
   /* parameter number in rgbValue instead of a buffer address.   */
   SQLBindParameter(hstmt, 1, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR,
<BR>               NAME_LEN, 0, 1, 0, &amp;cbNameParam);
   SQLBindParameter(hstmt, 2, SQL_PARAM_INPUT, SQL_C_SSHORT,
<BR>                    SQL_SMALLINT, 0, 0, &amp;sID, 0, &amp;cbID);
   SQLBindParameter(hstmt, 3, SQL_PARAM_INPUT,
<BR>                    SQL_C_BINARY, SQL_LONGVARBINARY,
<BR>                    0, 0, 3, 0, &amp;cbPhotoParam);
   /* Set values so data for parameters 1 and 3 will be passed  */
   /* at execution. Note that the length parameter in the macro */
   /* SQL_LEN_DATA_AT_EXEC is 0. This assumes that the driver   */
   /* returns &quot;N&quot; for the SQL_NEED_LONG_DATA_LEN information    */
   /* type in SQLGetInfo.                                       */
   cbNameParam = cbPhotoParam = SQL_LEN_DATA_AT_EXEC(0);
   sID = GetNextID();  /* Get next available employee ID number. */
   retcode = SQLExecute(hstmt);
   /* For data-at-execution parameters, call SQLParamData to get the */
   /* parameter number set by SQLBindParameter. Call InitUserData.   */
   /* Call GetUserData and SQLPutData repeatedly to get and put all  */
   /* data for the parameter. Call SQLParamData to finish processing */
   /* this parameter and start processing the next parameter.        */
   while (retcode == SQL_NEED_DATA) {
      retcode = SQLParamData(hstmt, &amp;pToken);
      if (retcode == SQL_NEED_DATA) {
         InitUserData((SWORD)pToken, InitValue);
         while (GetUserData(InitValue, (SWORD)pToken, Data, &amp;cbData))
            SQLPutData(hstmt, Data, cbData);
      }
   }
}
VOID InitUserData(sParam, InitValue)
SWORD sParam;
PTR   InitValue;
{
UCHAR  szPhotoFile[MAX_FILE_NAME_LEN];
switch sParam {
   case 3:
      /* Prompt user for bitmap file containing employee photo.    */
      /* OpenPhotoFile opens the file and returns the file handle. */
      PromptPhotoFileName(szPhotoFile);
      OpenPhotoFile(szPhotoFile, (FILE *)InitValue);
      break;
}
}
BOOL GetUserData(InitValue, sParam, Data, cbData)
PTR    InitValue;
SWORD  sParam;
UCHAR  *Data;
SDWORD *cbData;
{
switch sParam {
   case 1:
      /* Prompt user for employee name. */
      PromptEmployeeName(Data);
      *cbData = SQL_NTS;
      return (TRUE);
   case 3:
      /* GetNextPhotoData returns the next piece of photo data and  */
      /* the number of bytes of data returned (up to MAX_DATA_LEN). */
      Done = GetNextPhotoData((FILE *)InitValue, Data,
<BR>                              MAX_DATA_LEN, &amp;cbData);
      if (Done) {
         ClosePhotoFile((FILE *)InitValue);
         return (TRUE);
      }
      return (FALSE);
}
return (FALSE);
}</FONT></PRE></BLOCKQUOTE>
<A NAME="E11E302"></A>
<H3>
<FONT FACE="Arial">Related Functions</FONT></H3>

<TABLE WIDTH=800 >
<TR>
<TD WIDTH=240 VALIGN=top >
<BLOCKQUOTE>
<P><B>For information about</B>
</BLOCKQUOTE></TD>
<TD WIDTH=213 VALIGN=top >
<A NAME="E7E1588"></A>
<P>See</TD>
</TR>
<TR>
<TD WIDTH=240 VALIGN=top >
<BLOCKQUOTE>
<P>Canceling statement processing
</BLOCKQUOTE></TD>
<TD WIDTH=213 VALIGN=top >
<A NAME="E7E1589"></A>
<P><B>SQLCancel</B></TD>
</TR>
<TR>
<TD WIDTH=240 VALIGN=top >
<BLOCKQUOTE>
<P>Executing an SQL statement
</BLOCKQUOTE></TD>
<TD WIDTH=213 VALIGN=top >
<A NAME="E7E1590"></A>
<P><B>SQLExecDirect</B></TD>
</TR>
<TR>
<TD WIDTH=240 VALIGN=top >
<BLOCKQUOTE>
<P>Executing a prepared SQL statement
</BLOCKQUOTE></TD>
<TD WIDTH=213 VALIGN=top >
<A NAME="E7E1591"></A>
<P><B>SQLExecute</B></TD>
</TR>
<TR>
<TD WIDTH=240 VALIGN=top >
<BLOCKQUOTE>
<P>Returning the next parameter to send data for
</BLOCKQUOTE></TD>
<TD WIDTH=213 VALIGN=top >
<A NAME="E7E1592"></A>
<P><B>SQLParamData</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=240 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a parameter
</BLOCKQUOTE></TD>
<TD WIDTH=213 VALIGN=top >
<A NAME="E7E1593"></A>
<P><B>SQLBindParameter</B></TD></TR></TABLE><P ALIGN=CENTER>
<A HREF="prguid21.htm" TARGET="_self"><IMG SRC="graprev.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Previous Page"></A>
<A HREF="httoc.htm" TARGET="_self"><IMG SRC="gratoc.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="TOC"></A>
<A HREF="htindex.htm" TARGET="_self"><IMG SRC="graindex.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Index"></A>
<A HREF="prguid23.htm" TARGET="_self"><IMG SRC="granext.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Next Page"></A>

<center><p><font SIZE=-2>Copyright &copy; 1992-1997 Solid Information Technology Ltd All rights reserved.</font></p></center>
</BODY></HTML>