ibm-information-center/dist/eclipse/plugins/i5OS.ic.cli_5.4.0.1/rzadpfnnrcol.htm

127 lines
7.9 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="SQLNumResultCols - Get number of result columns" />
<meta name="DC.Relation" scheme="URI" content="rzadphdapi.htm" />
<meta name="DC.Relation" scheme="URI" content="rzadpprocupd.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzadpfnnrcol" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>SQLNumResultCols</title>
</head>
<body id="rzadpfnnrcol"><a name="rzadpfnnrcol"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">SQLNumResultCols - Get number of result columns</h1>
<div><div class="section"></div>
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLNumResultCols()</samp> returns
the number of columns in the result set associated with the input statement
handle.</p>
<p><samp class="codeph">SQLPrepare()</samp> or <samp class="codeph">SQLExecDirect()</samp> must
be called before calling this function.</p>
<p>After calling this function,
you can call <samp class="codeph">SQLDescribeCol()</samp>, <samp class="codeph">SQLColAttributes()</samp>, <samp class="codeph">SQLBindCol()</samp> or <samp class="codeph">SQLGetData()</samp>.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLNumResultCols (SQLHSTMT hstmt,
SQLSMALLINT *pccol);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Function arguments</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="hsides" border="1" rules="all"><caption>Table 1. SQLNumResultCols arguments</caption><thead align="left"><tr><th align="left" valign="top" width="26.95167286245353%" id="d0e74">Data type</th>
<th align="left" valign="top" width="18.21561338289963%" id="d0e76">Argument</th>
<th align="left" valign="top" width="16.728624535315987%" id="d0e78">Use</th>
<th align="left" valign="top" width="38.10408921933085%" id="d0e80">Description</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="26.95167286245353%" headers="d0e74 ">SQLHSTMT</td>
<td align="left" valign="top" width="18.21561338289963%" headers="d0e76 "><em>hstmt</em></td>
<td align="left" valign="top" width="16.728624535315987%" headers="d0e78 ">Input</td>
<td align="left" valign="top" width="38.10408921933085%" headers="d0e80 ">Statement handle.</td>
</tr>
<tr><td align="left" valign="top" width="26.95167286245353%" headers="d0e74 ">SQLSMALLINT *</td>
<td align="left" valign="top" width="18.21561338289963%" headers="d0e76 "><em>pccol</em></td>
<td align="left" valign="top" width="16.728624535315987%" headers="d0e78 ">Output</td>
<td align="left" valign="top" width="38.10408921933085%" headers="d0e80 ">Number of columns in the result set.</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The function sets the output argument to zero
if the last statement processed on the input statement handle is not a SELECT.</p>
</div>
<div class="section"><h4 class="sectiontitle">Return codes</h4><ul><li>SQL_SUCCESS</li>
<li>SQL_ERROR</li>
<li>SQL_INVALID_HANDLE</li>
</ul>
</div>
<div class="section"><h4 class="sectiontitle">Diagnostics</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="hsides" border="1" rules="rows"><caption>Table 2. SQLNumResultCols SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e133">SQLSTATE</th>
<th align="left" valign="top" width="25%" id="d0e135">Description</th>
<th align="left" valign="top" width="50%" id="d0e137">Explanation</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e133 "><strong>40</strong>003 <strong>*</strong></td>
<td align="left" valign="top" width="25%" headers="d0e135 ">Statement completion unknown</td>
<td align="left" valign="top" width="50%" headers="d0e137 ">The communication link between the CLI and
the data source fails before the function completes processing.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e133 "><strong>58</strong>004</td>
<td align="left" valign="top" width="25%" headers="d0e135 ">System error</td>
<td align="left" valign="top" width="50%" headers="d0e137 ">Unrecoverable system error.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e133 "><strong>HY</strong>001</td>
<td align="left" valign="top" width="25%" headers="d0e135 ">Memory allocation failure</td>
<td align="left" valign="top" width="50%" headers="d0e137 ">The driver is unable to allocate memory required
to support the processing or completion of the function.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e133 "><strong>HY</strong>009</td>
<td align="left" valign="top" width="25%" headers="d0e135 ">Argument value that is not valid</td>
<td align="left" valign="top" width="50%" headers="d0e137 "><em>pcbCol</em> is a null pointer.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e133 "><strong>HY</strong>010</td>
<td align="left" valign="top" width="25%" headers="d0e135 ">Function sequence error</td>
<td align="left" valign="top" width="50%" headers="d0e137 ">The function is called before calling SQLPrepare
or SQLExecDirect for the <em>hstmt</em>.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e133 "><strong>S1</strong>013 <strong>*</strong></td>
<td align="left" valign="top" width="25%" headers="d0e135 ">Memory management problem.</td>
<td align="left" valign="top" width="50%" headers="d0e137 ">The driver is unable to access memory required
to support the processing or completion of the function.</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">References</h4><ul><li><a href="rzadpfnbindc.htm#rzadpfnbindc">SQLBindCol - Bind a column to an application variable</a></li>
<li><a href="rzadpfncolat.htm#rzadpfncolat">SQLColAttributes - Obtain column attributes</a></li>
<li><a href="rzadpfndecol.htm#rzadpfndecol">SQLDescribeCol - Describe column attributes</a></li>
<li><a href="rzadpfnexecd.htm#rzadpfnexecd">SQLExecDirect - Execute a statement directly</a></li>
<li><a href="rzadpfngcol.htm#rzadpfngcol">SQLGetCol - Retrieve one column of a row of the result set</a></li>
<li><a href="rzadpfnprep.htm#rzadpfnprep">SQLPrepare - Prepare a statement</a></li>
</ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzadphdapi.htm" title="This topic provides a description of each CLI function.">DB2 UDB CLI functions</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<div><a href="rzadpprocupd.htm">Process UPDATE, DELETE, and INSERT statements in a DB2 UDB CLI application</a></div>
</div>
</div>
</body>
</html>