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

124 lines
7.3 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="SQLRowCount - Get row count" />
<meta name="DC.Relation" scheme="URI" content="rzadphdapi.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="rzadpfnrowc" />
<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>SQLRowCount</title>
</head>
<body id="rzadpfnrowc"><a name="rzadpfnrowc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">SQLRowCount - Get row count</h1>
<div><div class="section"></div>
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLRowCount()</samp> returns
the number of rows in a table affected by an UPDATE, INSERT, or DELETE statement
processed against the table, or a view based on the table.</p>
<p><samp class="codeph">SQLExecute()</samp> or <samp class="codeph">SQLExecDirect()</samp> must
be called before calling this function.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLRowCount (SQLHSTMT hstmt,
SQLINTEGER *pcrow);</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. SQLRowCount arguments</caption><thead align="left"><tr><th align="left" valign="top" width="26.355140186915886%" id="d0e55">Data type</th>
<th align="left" valign="top" width="18.50467289719626%" id="d0e57">Argument</th>
<th align="left" valign="top" width="18.317757009345794%" id="d0e59">Use</th>
<th align="left" valign="top" width="36.822429906542055%" id="d0e61">Description</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="26.355140186915886%" headers="d0e55 ">SQLHSTMT</td>
<td align="left" valign="top" width="18.50467289719626%" headers="d0e57 "><em>hstmt</em></td>
<td align="left" valign="top" width="18.317757009345794%" headers="d0e59 ">Input</td>
<td align="left" valign="top" width="36.822429906542055%" headers="d0e61 ">Statement handle.</td>
</tr>
<tr><td align="left" valign="top" width="26.355140186915886%" headers="d0e55 ">SQLINTEGER *</td>
<td align="left" valign="top" width="18.50467289719626%" headers="d0e57 "><em>pcrow</em></td>
<td align="left" valign="top" width="18.317757009345794%" headers="d0e59 ">Output</td>
<td align="left" valign="top" width="36.822429906542055%" headers="d0e61 ">Pointer to location where the number of rows
affected is stored.</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>If the last processed statement referenced
by the input statement handle is not an UPDATE, INSERT, or DELETE statement,
or if it is not processed successfully, then the function sets the contents
of <em>pcrow</em> to 0.</p>
<p>Any rows in other tables that might have been
affected by the statement (for example, cascading deletes) are not included
in the count.</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. SQLRowCount SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e119">SQLSTATE</th>
<th align="left" valign="top" width="25%" id="d0e121">Description</th>
<th align="left" valign="top" width="50%" id="d0e123">Explanation</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e119 "><strong>40</strong>003 <strong>*</strong></td>
<td align="left" valign="top" width="25%" headers="d0e121 ">Statement completion unknown</td>
<td align="left" valign="top" width="50%" headers="d0e123 ">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="d0e119 "><strong>58</strong>004</td>
<td align="left" valign="top" width="25%" headers="d0e121 ">System error</td>
<td align="left" valign="top" width="50%" headers="d0e123 ">Unrecoverable system error.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e119 "><strong>HY</strong>001</td>
<td align="left" valign="top" width="25%" headers="d0e121 ">Memory allocation failure</td>
<td align="left" valign="top" width="50%" headers="d0e123 ">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="d0e119 "><strong>HY</strong>009</td>
<td align="left" valign="top" width="25%" headers="d0e121 ">Argument value that is not valid</td>
<td align="left" valign="top" width="50%" headers="d0e123 "><em>pcrow</em> is a null pointer.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e119 "><strong>HY</strong>010</td>
<td align="left" valign="top" width="25%" headers="d0e121 ">Function sequence error</td>
<td align="left" valign="top" width="50%" headers="d0e123 ">The function is called before calling SQLExecute
or SQLExecDirect for the <em>hstmt</em>.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e119 "><strong>HY</strong>013 <strong>*</strong></td>
<td align="left" valign="top" width="25%" headers="d0e121 ">Memory management problem</td>
<td align="left" valign="top" width="50%" headers="d0e123 ">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="rzadpfnexecd.htm#rzadpfnexecd">SQLExecDirect - Execute a statement directly</a></li>
<li><a href="rzadpfnexec.htm#rzadpfnexec">SQLExecute - Execute a statement</a></li>
<li><a href="rzadpfnnrcol.htm#rzadpfnnrcol">SQLNumResultCols - Get number of result columns</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>
</body>
</html>