File: prguid21.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 (1430 lines) | stat: -rw-r--r-- 47,322 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="prguid22.htm">
<LINK REL="Previous" HREF="prguid20.htm"></HEAD>
<BODY BGCOLOR="#FFFFFF">
<P ALIGN=CENTER>
<A HREF="prguid20.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="prguid22.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="#E74E8" >SQLNativeSql (ODBC 1.0, Level 2)</A>
<UL>
<LI>
<A HREF="#E11E246" >Syntax</A>
<LI>
<A HREF="#E11E247" >Returns</A>
<LI>
<A HREF="#E11E248" >Diagnostics</A>
<LI>
<A HREF="#E11E249" >Comments</A>
<LI>
<A HREF="#E11E250" >Related Functions</A></UL>
<LI>
<A HREF="#E10E92" >SQLNumParams (ODBC 1.0, Level 2)</A>
<UL>
<LI>
<A HREF="#E11E251" >Syntax</A>
<LI>
<A HREF="#E11E252" >Returns</A>
<LI>
<A HREF="#E11E253" >Diagnostics</A>
<LI>
<A HREF="#E11E254" >Comments</A>
<LI>
<A HREF="#E11E255" >Related Functions</A></UL>
<LI>
<A HREF="#E10E93" >SQLNumResultCols (ODBC 1.0, Core)</A>
<UL>
<LI>
<A HREF="#E11E256" >Syntax</A>
<LI>
<A HREF="#E11E257" >Returns</A>
<LI>
<A HREF="#E11E258" >Diagnostics</A>
<LI>
<A HREF="#E11E259" >Comments</A>
<LI>
<A HREF="#E11E260" >Related Functions</A></UL>
<LI>
<A HREF="#E10E94" >SQLParamData (ODBC 1.0, Level 1)</A>
<UL>
<LI>
<A HREF="#E11E261" >Syntax</A>
<LI>
<A HREF="#E11E262" >Returns</A>
<LI>
<A HREF="#E11E263" >Diagnostics</A>
<LI>
<A HREF="#E11E264" >Comments</A>
<LI>
<A HREF="#E11E265" >Code Example</A>
<LI>
<A HREF="#E11E266" >Related Functions</A></UL>
<LI>
<A HREF="#E10E95" >SQLParamOptions (ODBC 1.0, Level 2)</A>
<UL>
<LI>
<A HREF="#E11E267" >Syntax</A>
<LI>
<A HREF="#E11E268" >Returns</A>
<LI>
<A HREF="#E11E269" >Diagnostics</A>
<LI>
<A HREF="#E11E270" >Comments</A>
<LI>
<A HREF="#E11E271" >Code Example</A>
<LI>
<A HREF="#E11E272" >Related Functions</A></UL></UL></UL>
<HR ALIGN=CENTER>
<A NAME="E74E8"></A>
<H2>
<FONT FACE="Arial"><B>SQLNativeSql (ODBC 1.0, Level 2)</B><A NAME="I2"></A><A NAME="I3"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLNativeSql</B> returns the SQL string as translated by the driver.
</BLOCKQUOTE>
<A NAME="E11E246"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLNativeSql</B>(<I>hdbc</I>, <I>szSqlStrIn</I>, <I>cbSqlStrIn</I>, <I>szSqlStr</I>, <I>cbSqlStrMax</I>, <I>pcbSqlStr</I>)<A NAME="I4"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLNativeSql</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=86 VALIGN=top >
<A NAME="E7E1322"></A>
<P>Argument
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1322"></A>
<P>Use
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1322"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>HDBC
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1323"></A>
<P><I>hdbc</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1323"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1323"></A>
<P>Connection handle.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1324"></A>
<P><I>szSqlStrIn</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1324"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1324"></A>
<P>SQL text string to be translated.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SDWORD
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1325"></A>
<P><I>cbSqlStrIn</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1325"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1325"></A>
<P>Length of <I>szSqlStrIn</I> text string.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>UCHAR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1326"></A>
<P><I>szSqlStr</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1326"></A>
<P>Output
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1326"></A>
<P>Pointer to storage for the translated SQL string.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SDWORD
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1327"></A>
<P><I>cbSqlStrMax</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1327"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1327"></A>
<P>Maximum length of the <I>szSqlStr</I> buffer.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SDWORD FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1328"></A>
<P><I>pcbSqlStr</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1328"></A>
<P>Output
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1328"></A>
<P>The total number of bytes (excluding the null termination byte) available to return in <I>szSqlStr</I>. If the number of bytes available to return is greater than or equal to <I>cbSqlStrMax</I>, the translated SQL string in <I>szSqlStr</I> is truncated to <I>cbSqlStrMax &#150; </I>1 bytes.</TD></TR></TABLE>
<A NAME="E11E247"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I5"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E248"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I6"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLNativeSql</B> returns either 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>SQLNativeSql </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=140 VALIGN=top >
<A NAME="E7E1329"></A>
<P>Error
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1329"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1330"></A>
<P>General warning
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1330"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>01004
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1331"></A>
<P>Data truncated
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1331"></A>
<P>The buffer <I>szSqlStr</I> was not large enough to return the entire SQL string, so the SQL string was truncated. The argument <I>pcbSqlStr</I> contains the length of the untruncated SQL string. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>08003
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1332"></A>
<P>Connection not open
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1332"></A>
<P>The <I>hdbc</I> was not in a connected state.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>37000
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1333"></A>
<P>Syntax error or access violation
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1333"></A>
<P>The argument <I>szSqlStrIn</I> contained an SQL statement that was not preparable or contained a syntax error.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1334"></A>
<P>Driver does not support this function
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1334"></A>
<P>(DM) The driver associated with the <I>hdbc</I> does not support the function.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1000
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1335"></A>
<P>General error
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1335"></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=140 VALIGN=top >
<A NAME="E7E1336"></A>
<P>Memory allocation failure
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1336"></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>S1009
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1337"></A>
<P>Invalid argument value
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1337"></A>
<P>(DM) The argument <I>szSqlStrIn</I> was a null pointer.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>S1090
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1338"></A>
<P>Invalid string or buffer length
</TD><TD WIDTH=209 VALIGN=top >
<A NAME="E7E1338"></A>
<P>(DM) The argument <I>cbSqlStrIn</I> was less than 0, but not equal to SQL_NTS. </TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top ><BR></TD>
<TD WIDTH=140 VALIGN=top ><BR></TD>
<TD WIDTH=209 VALIGN=top >
<BLOCKQUOTE>
<P>(DM) The argument <I>cbSqlStrMax</I> was less 
<BR>than 0 and the argument <I>szSqlStr</I> was not a null pointer..</TD></TR></BLOCKQUOTE></TABLE>
<A NAME="E11E249"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I7"></A></FONT></H3>
<BLOCKQUOTE>
<P>The following are examples of what <B>SQLNativeSql</B> might return for the following input SQL string containing the scalar function CONVERT. Assume that the column empid is of type INTEGER in the data source:
</BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
<FONT FACE="Courier New">SELECT { fn CONVERT (empid, SQL_SMALLINT) } FROM employee<A NAME="I8"></A></FONT></PRE></BLOCKQUOTE>
<BLOCKQUOTE>
<P>A driver for SQL Server might return the following translated SQL string:
</BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
<FONT FACE="Courier New">SELECT convert (smallint, empid) FROM employee<A NAME="I9"></A></FONT></PRE></BLOCKQUOTE>
<BLOCKQUOTE>
<P>A driver for ORACLE Server might return the following translated SQL string:
</BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
<FONT FACE="Courier New">SELECT to_number (empid) FROM employee<A NAME="I10"></A></FONT></PRE></BLOCKQUOTE>
<BLOCKQUOTE>
<P>A driver for Ingres might return the following translated SQL string:
</BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
<FONT FACE="Courier New">SELECT int2 (empid) FROM employee</FONT></PRE></BLOCKQUOTE>
<A NAME="E11E250"></A>
<H3>
<FONT FACE="Arial">Related Functions<A NAME="I11"></A></FONT></H3>
<BLOCKQUOTE>
<P>None.
</BLOCKQUOTE>
<A NAME="E10E92"></A>
<H2>
<FONT FACE="Arial"><B>SQLNumParams (ODBC 1.0, Level 2)</B><A NAME="I12"></A><A NAME="I13"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLNumParams</B> returns the number of parameters in an SQL statement.
</BLOCKQUOTE>
<A NAME="E11E251"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLNumParams</B>(<I>hstmt</I>, <I>pcpar</I>)<A NAME="I14"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLNumParams</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=86 VALIGN=top >
<A NAME="E7E1339"></A>
<P>Argument
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1339"></A>
<P>Use
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1339"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1340"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1340"></A>
<P>Input
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1340"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1341"></A>
<P><I>pcpar</I>
</TD><TD WIDTH=73 VALIGN=top >
<A NAME="E7E1341"></A>
<P>Output
</TD><TD WIDTH=186 VALIGN=top >
<A NAME="E7E1341"></A>
<P>Number of parameters in the statement.</TD></TR></TABLE>
<A NAME="E11E252"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I15"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E253"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I16"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLNumParams</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>SQLNumParams </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=120 VALIGN=top >
<A NAME="E7E1342"></A>
<P>Error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1342"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=120 VALIGN=top >
<A NAME="E7E1343"></A>
<P>General warning
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1343"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=100 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=120 VALIGN=top >
<A NAME="E7E1344"></A>
<P>Driver does not support this function
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1344"></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=120 VALIGN=top >
<A NAME="E7E1345"></A>
<P>General error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1345"></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=120 VALIGN=top >
<A NAME="E7E1346"></A>
<P>Memory allocation failure
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1346"></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=120 VALIGN=top >
<A NAME="E7E1347"></A>
<P>Operation canceled
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1347"></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=120 VALIGN=top >
<A NAME="E7E1348"></A>
<P>Function sequence error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1348"></A>
<P>(DM) The function was called prior to calling <B>SQLPrepare</B> or <B>SQLExecDirect</B> for the <I>hstmt</I>.
<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.
</BLOCKQUOTE>
<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>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=120 VALIGN=top >
<A NAME="E7E1349"></A>
<P>Timeout expired
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1349"></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="E11E254"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I17"></A></FONT></H3>
<BLOCKQUOTE>
<P><B>SQLNumParams</B> can only be called after <B>SQLPrepare</B> has been called.<A NAME="I18"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>If the statement associated with <I>hstmt</I> does not contain parameters, <B>SQLNumParams</B> sets <I>pcpar</I> to 0.
</BLOCKQUOTE>
<A NAME="E11E255"></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=196 VALIGN=top >
<A NAME="E7E1350"></A>
<P>See</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Returning information about a parameter in a statement
</BLOCKQUOTE></TD>
<TD WIDTH=196 VALIGN=top >
<A NAME="E7E1351"></A>
<P><B>SQLDescribeParam</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a parameter
</BLOCKQUOTE></TD>
<TD WIDTH=196 VALIGN=top >
<A NAME="E7E1352"></A>
<P><B>SQLBindParameter</B></TD></TR></TABLE><A NAME="E10E93"></A>
<H2>
<FONT FACE="Arial"><B>SQLNumResultCols (ODBC 1.0, Core)</B><A NAME="I19"></A><A NAME="I20"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLNumResultCols</B> returns the number of columns in a result set.
</BLOCKQUOTE>
<A NAME="E11E256"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLNumResultCols</B>(<I>hstmt</I>, <I>pccol</I>)<A NAME="I21"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLNumResultCols</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="E7E1353"></A>
<P>Argument
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1353"></A>
<P>Use
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1353"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=80 VALIGN=top >
<A NAME="E7E1354"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1354"></A>
<P>Input
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1354"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>SWORD FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=80 VALIGN=top >
<A NAME="E7E1355"></A>
<P><I>pccol</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1355"></A>
<P>Output
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1355"></A>
<P>Number of columns in the result set.</TD></TR></TABLE>
<A NAME="E11E257"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I22"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E258"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I23"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLNumResultCols</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>SQLNumResultCols </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=146 VALIGN=top >
<A NAME="E7E1356"></A>
<P>Error
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1356"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=146 VALIGN=top >
<A NAME="E7E1357"></A>
<P>General warning
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1357"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=93 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=146 VALIGN=top >
<A NAME="E7E1358"></A>
<P>Driver does not support this function
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1358"></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=146 VALIGN=top >
<A NAME="E7E1359"></A>
<P>General error
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1359"></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=146 VALIGN=top >
<A NAME="E7E1360"></A>
<P>Memory allocation failure
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1360"></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=146 VALIGN=top >
<A NAME="E7E1361"></A>
<P>Operation canceled
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1361"></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=146 VALIGN=top >
<A NAME="E7E1362"></A>
<P>Function sequence error
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1362"></A>
<P>(DM) The function was called prior to calling <B>SQLPrepare</B> or <B>SQLExecDirect</B> for the <I>hstmt</I>.
<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.
</BLOCKQUOTE>
<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>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=146 VALIGN=top >
<A NAME="E7E1363"></A>
<P>Timeout expired
</TD><TD WIDTH=213 VALIGN=top >
<A NAME="E7E1363"></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="I24"></A>
<BLOCKQUOTE>
<P><B>SQLNumResultCols</B> can return any SQLSTATE that can be returned by <B>SQLPrepare</B> or <B>SQLExecute</B> when called after <B>SQLPrepare</B> and before <B>SQLExecute</B> depending on when the data source evaluates the SQL statement associated with the <I>hstmt</I>.
</BLOCKQUOTE>
<A NAME="E11E259"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I25"></A></FONT></H3>
<BLOCKQUOTE>
<P><B>SQLNumResultCols</B> can be called successfully only when the <I>hstmt</I> is in the prepared, executed, or positioned state.<A NAME="I26"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>If the statement associated with <I>hstmt</I> does not return columns, <B>SQLNumResultCols</B> sets <I>pccol</I> to 0.
</BLOCKQUOTE>
<A NAME="E11E260"></A>
<H3>
<FONT FACE="Arial">Related Functions</FONT></H3>

<TABLE WIDTH=800 >
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P><B>For information about</B>
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1364"></A>
<P>See</TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a column in a result set
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1365"></A>
<P><B>SQLBindCol</B></TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Canceling statement processing
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1366"></A>
<P><B>SQLCancel</B></TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Returning information about a column in a result set
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1367"></A>
<P><B>SQLColAttributes</B></TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Returning information about a column in a result set
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1368"></A>
<P><B>SQLDescribeCol</B></TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a block of data or scrolling through a result set
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1369"></A>
<P><B>SQLExtendedFetch</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching a row of data
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1370"></A>
<P><B>SQLFetch</B></TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Fetching part or all of a column of data
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1371"></A>
<P><B>SQLGetData</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=253 VALIGN=top >
<BLOCKQUOTE>
<P>Setting cursor scrolling options
</BLOCKQUOTE></TD>
<TD WIDTH=200 VALIGN=top >
<A NAME="E7E1372"></A>
<P><B>SQLSetScrollOptions</B> (extension)</TD></TR></TABLE><A NAME="E7E1372"></A>
<A NAME="E10E94"></A>
<H2>
<FONT FACE="Arial"><B>SQLParamData (ODBC 1.0, Level 1)</B><A NAME="I27"></A><A NAME="I28"></A><A NAME="I29"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLParamData</B> is used in conjunction with <B>SQLPutData</B> to supply parameter data at statement execution time.
</BLOCKQUOTE>
<A NAME="E11E261"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLParamData</B>(<I>hstmt</I>, <I>prgbValue</I>)<A NAME="I30"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLParamData</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="E7E1373"></A>
<P>Argument
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1373"></A>
<P>Use
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1373"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=73 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1374"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1374"></A>
<P>Input
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1374"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=73 VALIGN=top >
<BLOCKQUOTE>
<P>PTR FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1375"></A>
<P><I>prgbValue</I>
</TD><TD WIDTH=66 VALIGN=top >
<A NAME="E7E1375"></A>
<P>Output
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1375"></A>
<P>Pointer to storage for the value specified for the <I>rgbValue</I> argument in <B>SQLBindParameter</B> (for parameter data) or the address of the <I>rgbValue</I> buffer specified in <B>SQLBindCol</B> (for column data).</TD></TR></TABLE>
<A NAME="E11E262"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I31"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NEED_DATA, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E263"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I32"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLParamData</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>SQLParamData </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=140 VALIGN=top >
<A NAME="E7E1376"></A>
<P>Error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1376"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1377"></A>
<P>General warning
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1377"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>08S01
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1378"></A>
<P>Communication link failure
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1378"></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>22026
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1379"></A>
<P>String data, length mismatch
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1379"></A>
<P>The SQL_NEED_LONG_DATA_LEN information type in <B>SQLGetInfo</B> was &quot;Y&quot; and less 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 less 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>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1380"></A>
<P>Driver does not support this function
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1380"></A>
<P>(DM) The driver that corresponds the <I>hstmt</I> does not support the function.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1000
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1381"></A>
<P>General error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1381"></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=140 VALIGN=top >
<A NAME="E7E1382"></A>
<P>Memory allocation failure
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1382"></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=140 VALIGN=top >
<A NAME="E7E1383"></A>
<P>Operation canceled
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1383"></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>S1010
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1384"></A>
<P>Function sequence error
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1384"></A>
<P>(DM) The previous function call was not a call to <B>SQLExecDirect</B>, <B>SQLExecute</B>, or <B>SQLSetPos</B> where the return code was SQL_NEED_DATA or a call to <B>SQLPutData</B>.
<BLOCKQUOTE>
<P>The previous function call was a call to <B>SQLParamData</B>.
</BLOCKQUOTE>
<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>S1T00
</BLOCKQUOTE></TD>
<TD WIDTH=140 VALIGN=top >
<A NAME="E7E1385"></A>
<P>Timeout expired
</TD><TD WIDTH=226 VALIGN=top >
<A NAME="E7E1385"></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="I33"></A>
<BLOCKQUOTE>
<P>If <B>SQLParamData</B> is called while sending data for a parameter in an SQL statement, it can return any SQLSTATE that can be returned by the function called to execute the statement (<B>SQLExecute</B> or <B>SQLExecDirect</B>). If it is called while sending data for a column being updated or added with <B>SQLSetPos</B>, it can return any SQLSTATE that can be returned by <B>SQLSetPos</B>.
</BLOCKQUOTE>
<A NAME="E11E264"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I34"></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>.
</BLOCKQUOTE>
<A NAME="E11E265"></A>
<H3>
<FONT FACE="Arial">Code Example<A NAME="I35"></A></FONT></H3>
<BLOCKQUOTE>
<P>See <B>SQLPutData</B>.
</BLOCKQUOTE>
<A NAME="E11E266"></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="E7E1386"></A>
<P>See</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Canceling statement processing
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1387"></A>
<P><B>SQLCancel</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Returning information about a parameter in a statement
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1388"></A>
<P><B>SQLDescribeParam</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Executing an SQL statement
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1389"></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="E7E1390"></A>
<P><B>SQLExecute</B></TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Sending parameter data at execution time
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1391"></A>
<P><B>SQLPutData</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a parameter
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1392"></A>
<P><B>SQLBindParameter</B></TD></TR></TABLE><A NAME="E10E95"></A>
<H2>
<FONT FACE="Arial"><B>SQLParamOptions (ODBC 1.0, Level 2)</B><A NAME="I36"></A><A NAME="I37"></A><A NAME="I38"></A><A NAME="I39"></A><A NAME="I40"></A><A NAME="I41"></A><A NAME="I42"></A></FONT></H2>
<BLOCKQUOTE>
<P><B>SQLParamOptions </B>allows an application to specify multiple values for the set of parameters assigned by <B>SQLBindParameter</B>. The ability to specify multiple values for a set of parameters is useful for bulk inserts and other work that requires the data source to process the same SQL statement multiple times with various parameter values. An application can, for example, specify three sets of values for the set of parameters associated with an <B>INSERT</B> statement, and then execute the <B>INSERT</B> statement once to perform the three insert operations.
</BLOCKQUOTE>
<A NAME="E11E267"></A>
<H3>
<FONT FACE="Arial">Syntax</FONT></H3>
<BLOCKQUOTE>
<P>RETCODE <B>SQLParamOptions</B>(<I>hstmt</I>, <I>crow</I>, <I>pirow</I>)<A NAME="I43"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The <B>SQLParamOptions</B> function accepts the following arguments:
</BLOCKQUOTE>
<TABLE WIDTH=800 >
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P><B>Type</B>
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1393"></A>
<P>Argument
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1393"></A>
<P>Use
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1393"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>HSTMT 
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1394"></A>
<P><I>hstmt</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1394"></A>
<P>Input
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1394"></A>
<P>Statement handle.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>UDWORD
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1395"></A>
<P><I>crow</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1395"></A>
<P>Input
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1395"></A>
<P>Number of values for each parameter. If <I>crow</I> is greater than 1, the <I>rgbValue</I> argument in <B>SQLBindParameter</B> points to an array of parameter values and <I>pcbValue</I> points to an array of lengths.</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>UDWORD FAR *
</BLOCKQUOTE></TD>
<TD WIDTH=86 VALIGN=top >
<A NAME="E7E1396"></A>
<P><I>pirow</I>
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E1396"></A>
<P>Input
</TD><TD WIDTH=220 VALIGN=top >
<A NAME="E7E1396"></A>
<P>Pointer to storage for the current row number. As each row of parameter values is processed, <I>pirow</I> is set to the number of that row. No row number will be returned if <I>pirow</I> is set to a null pointer.</TD></TR></TABLE>
<A NAME="E11E268"></A>
<H3>
<FONT FACE="Arial">Returns<A NAME="I44"></A></FONT></H3>
<BLOCKQUOTE>
<P>SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.
</BLOCKQUOTE>
<A NAME="E11E269"></A>
<H3>
<FONT FACE="Arial">Diagnostics<A NAME="I45"></A></FONT></H3>
<BLOCKQUOTE>
<P>When <B>SQLParamOptions</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>SQLParamOptions </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=106 VALIGN=top >
<A NAME="E7E1397"></A>
<P>Error
</TD><TD WIDTH=260 VALIGN=top >
<A NAME="E7E1397"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>01000
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1398"></A>
<P>General warning
</TD><TD WIDTH=260 VALIGN=top >
<A NAME="E7E1398"></A>
<P>Driver-specific informational message. (Function returns SQL_SUCCESS_WITH_INFO.)</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>IM001
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1399"></A>
<P>Driver does not support this function
</TD><TD WIDTH=260 VALIGN=top >
<A NAME="E7E1399"></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=106 VALIGN=top >
<A NAME="E7E1400"></A>
<P>General error
</TD><TD WIDTH=260 VALIGN=top >
<A NAME="E7E1400"></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=106 VALIGN=top >
<A NAME="E7E1401"></A>
<P>Memory allocation failure
</TD><TD WIDTH=260 VALIGN=top >
<A NAME="E7E1401"></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>S1010
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1402"></A>
<P>Function sequence error
</TD><TD WIDTH=260 VALIGN=top >
<A NAME="E7E1402"></A>
<P>(DM) An asynchronously executing function 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=86 VALIGN=top >
<BLOCKQUOTE>
<P>S1107
</BLOCKQUOTE></TD>
<TD WIDTH=106 VALIGN=top >
<A NAME="E7E1403"></A>
<P>Row value out of range
</TD><TD WIDTH=260 VALIGN=top >
<A NAME="E7E1403"></A>
<P>(DM) The value specified for the argument <I>crow</I> was equal to 0.</TD></TR></TABLE>
<A NAME="E11E270"></A>
<H3>
<FONT FACE="Arial">Comments<A NAME="I46"></A></FONT></H3>
<BLOCKQUOTE>
<P>As a statement executes, the driver sets <I>pirow</I> to the number of the current row of parameter values; the first row is row number 1. The contents of <I>pirow</I> can be used as follows:<A NAME="I47"></A>
</BLOCKQUOTE>
<UL>
<BLOCKQUOTE>
<LI>When <B>SQLParamData</B> returns SQL_NEED_DATA for data-at-execution parameters, the application can access the value in <I>pirow</I> to determine which row of parameters is being executed.<A NAME="I48"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>When <B>SQLExecute</B> or <B>SQLExecDirect</B> returns an error, the application can access the value in <I>pirow</I> to find out which row of parameters failed.<A NAME="I49"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>When <B>SQLExecute</B>, <B>SQLExecDirect</B>, <B>SQLParamData</B>, or <B>SQLPutData</B> succeed, the value in <I>pirow</I> is set to <I>crow</I> &#151; the total number of rows of parameters processed.
</BLOCKQUOTE></UL>
<A NAME="E11E271"></A>
<H3>
<FONT FACE="Arial">Code Example<A NAME="I50"></A></FONT></H3>
<BLOCKQUOTE>
<P>In the following example, an application specifies an array of parameter values with <B>SQLBindParameter</B> and <B>SQLParamOptions</B>. It then inserts those values into a table with a single <B>INSERT</B> statement and checks for any errors. If the first row fails, the application rolls back all changes. If any other row fails, the application commits the transaction, skips the failed row, rebinds the remaining parameters, and continues processing. (Note that <B>irow</B> is 1-based and <B>szData[</B><B> </B><B>]</B> is 0-based, so the <B>irow</B> entry of <B>szData[</B><B> </B><B>]</B> is skipped by rebinding at <B>szData[irow]</B>.)
</BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
<FONT FACE="Courier New">#define CITY_LEN 256
SDWORD cbValue[ ] = {SQL_NTS, SQL_NTS, SQL_NTS, SQL_NTS, SQL_NTS};
UCHAR  szData[ ][CITY_LEN] = {&quot;Boston&quot;,&quot;New York&quot;,&quot;Keokuk&quot;,&quot;Seattle&quot;,
<BR>                              &quot;Eugene&quot;};
UDWORD irow;
SQLSetConnectOption(hdbc, SQL_AUTOCOMMIT, 0);
SQLBindParameter(hstmt, 1, SQL_PARAM_INPUT, SQL_C_DEFAULT, SQL_CHAR,
<BR>                 CITY_LEN, 0, szData, 0, cbValue);
SQLPrepare(hstmt, &quot;INSERT INTO CITIES VALUES (?)&quot;, SQL_NTS);
SQLParamOptions(hstmt, 5, &amp;irow);
while (TRUE) {
   retcode = SQLExecute(hstmt);
   /* Done if execution was successful */
   if (retcode != SQL_ERROR) {
      break;
   }
   /* On an error, print the error.  If the error is in row 1, roll */
   /* back the transaction and quit.  If the error is in another    */
   /* row, commit the transaction and, unless the error is in the   */
   /* last row, rebind to the next row and continue processing.     */
   show_error();
   if (irow == 1) {
      SQLTransact(henv, hstmt, SQL_ROLLBACK);
      break;
   } else {
      SQLTransact(henv, hstmt, SQL_COMMIT);
      if (irow == 5) {
         break;
      } else {
         SQLBindParameter(hstmt, 1, SQL_PARAM_INPUT,
<BR>                          SQL_C_DEFAULT, SQL_CHAR, CITY_LEN, 0,
<BR>                          szData[irow], 0, cbValue[irow]);
         SQLParamOptions(hstmt, 5-irow, &amp;irow);
      }
   }
}</FONT></PRE></BLOCKQUOTE>
<A NAME="E11E272"></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="E7E1404"></A>
<P>See</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Returning information about a parameter in a statement
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1405"></A>
<P><B>SQLDescribeParam</B> (extension)</TD>
</TR>
<TR>
<TD WIDTH=250 VALIGN=top >
<BLOCKQUOTE>
<P>Assigning storage for a parameter
</BLOCKQUOTE></TD>
<TD WIDTH=202 VALIGN=top >
<A NAME="E7E1406"></A>
<P><B>SQLBindParameter</B></TD></TR></TABLE><P ALIGN=CENTER>
<A HREF="prguid20.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="prguid22.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>