170 lines
11 KiB
HTML
170 lines
11 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="SQLGetDescRec - Get descriptor record" />
|
||
|
|
<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="rzadpgdesrec" />
|
||
|
|
<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>SQLGetDescRec</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzadpgdesrec"><a name="rzadpgdesrec"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">SQLGetDescRec - Get descriptor record</h1>
|
||
|
|
<div><div class="section"></div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLGetDescRec()</samp> obtains
|
||
|
|
an entire record from a descriptor. <samp class="codeph">SQLGetDescRec()</samp> is a
|
||
|
|
more concise alternative to the <samp class="codeph">SQLGetDescField()</samp> function.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLGetDescRec (SQLHDESC hdesc,
|
||
|
|
SQLSMALLINT irec,
|
||
|
|
SQLCHAR *rgbDesc,
|
||
|
|
SQLSMALLINT cbDescMax,
|
||
|
|
SQLSMALLINT *pcbDesc,
|
||
|
|
SQLSMALLINT *type,
|
||
|
|
SQLSMALLINT *subtype,
|
||
|
|
SQLINTEGER *length,
|
||
|
|
SQLSMALLINT *prec,
|
||
|
|
SQLSMALLINT *scale,
|
||
|
|
SQLSMALLINT *nullable);</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. SQLGetDescRec arguments</caption><thead align="left"><tr><th align="left" valign="top" width="22.962962962962962%" id="d0e54">Data type</th>
|
||
|
|
<th align="left" valign="top" width="21.666666666666668%" id="d0e56">Argument</th>
|
||
|
|
<th align="left" valign="top" width="15.185185185185185%" id="d0e58">Use</th>
|
||
|
|
<th align="left" valign="top" width="40.18518518518518%" id="d0e60">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLCHAR *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>rgbDesc</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">NAME field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLHDESC</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>hdesc</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">Descriptor handle.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLINTEGER *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>length</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">LENGTH field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>nullable</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">NULLABLE field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>pcbDesc</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">Total length of the output data.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>prec</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">PRECISION field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>scale</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">SCALE field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>subtype</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">DATETIME_INTERVAL_CODE, for records whose
|
||
|
|
TYPE is SQL_DATETIME.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT *</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>type</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">TYPE field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>cbDescMax</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">Maximum number of bytes to store in <em>rgbDesc</em>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.962962962962962%" headers="d0e54 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="21.666666666666668%" headers="d0e56 "><em>irec</em></td>
|
||
|
|
<td align="left" valign="top" width="15.185185185185185%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40.18518518518518%" headers="d0e60 ">The number of records in the descriptor matches
|
||
|
|
the number of columns in the result set for a row descriptor, or the number
|
||
|
|
of parameters in a parameter descriptor.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4> <p>Calling <samp class="codeph">SQLGetDescRec()</samp> retrieves
|
||
|
|
all the data from a descriptor record in one call. It might still be necessary
|
||
|
|
to call <samp class="codeph">SQLGetDescField()</samp> with SQL_DESC_COUNT to determine
|
||
|
|
the number of records in the descriptor.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Return codes</h4><ul><li>SQL_SUCCESS</li>
|
||
|
|
<li>SQL_SUCCESS_WITH_INFO</li>
|
||
|
|
<li>SQL_ERROR</li>
|
||
|
|
<li>SQL_INVALID_HANDLE</li>
|
||
|
|
<li>SQL_NO_DATA_FOUND</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. SQLGetDescRec SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e217">SQLSTATE</th>
|
||
|
|
<th align="left" valign="top" width="25%" id="d0e219">Description</th>
|
||
|
|
<th align="left" valign="top" width="50%" id="d0e221">Explanation</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e217 "><strong>HY</strong>009</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e219 ">Argument value that is not valid</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e221 ">The value specified for the argument <em>irec</em> is
|
||
|
|
not valid. <p>The argument <em>rgbDesc</em>, <em>pcbDesc</em>, <em>type</em>, <em>subtype</em>, <em>length</em>, <em>prec</em>, <em>scale</em> or <em>nullable</em> is a null pointer.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e217 "><strong>HY</strong>013 <strong>*</strong></td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e219 ">Memory management problem</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e221 ">The driver is unable to access memory required
|
||
|
|
to support the processing or completion of the function.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="25%" headers="d0e217 "><p><img src="./delta.gif" alt="Start of change" /><strong>HY</strong>021<img src="./deltaend.gif" alt="End of change" /></p>
|
||
|
|
</td>
|
||
|
|
<td valign="top" width="25%" headers="d0e219 "><p><img src="./delta.gif" alt="Start of change" />Internal descriptor that is not valid<img src="./deltaend.gif" alt="End of change" /></p>
|
||
|
|
</td>
|
||
|
|
<td valign="top" width="50%" headers="d0e221 "><p><img src="./delta.gif" alt="Start of change" />The internal descriptor
|
||
|
|
cannot be addressed or allocated, or it contains a value that is not valid.<img src="./deltaend.gif" alt="End of change" /></p>
|
||
|
|
</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="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="rzadpfnexec.htm#rzadpfnexec">SQLExecute - Execute a statement</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>
|
||
|
|
</body>
|
||
|
|
</html>
|