156 lines
9.6 KiB
HTML
156 lines
9.6 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="SQLSetDescRec - Set a 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="rzadpsetrec" />
|
||
|
|
<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>SQLSetDescRec - Set a descriptor record</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzadpsetrec"><a name="rzadpsetrec"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">SQLSetDescRec - Set a descriptor record</h1>
|
||
|
|
<div><div class="section"></div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLSetDescRec()</samp> sets
|
||
|
|
all the attributes for a descriptor record. <samp class="codeph">SQLSetDescRec()</samp> is
|
||
|
|
a more concise alternative to the <samp class="codeph">SQLDescField()</samp> function.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLSetDescRec (SQLHDESC hdesc,
|
||
|
|
SQLSMALLINT irec,
|
||
|
|
SQLSMALLINT type,
|
||
|
|
SQLSMALLINT subtype,
|
||
|
|
SQLINTEGER length,
|
||
|
|
SQLSMALLINT prec,
|
||
|
|
SQLSMALLINT scale,
|
||
|
|
SQLPOINTER data,
|
||
|
|
SQLINTEGER *sLen,
|
||
|
|
<span>SQLINTEGER</span> *indic);</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. SQLSetDescRec arguments</caption><thead align="left"><tr><th align="left" valign="top" width="22.22222222222222%" id="d0e54">Data type</th>
|
||
|
|
<th align="left" valign="top" width="21.296296296296298%" id="d0e56">Argument</th>
|
||
|
|
<th align="left" valign="top" width="16.48148148148148%" id="d0e58">Use</th>
|
||
|
|
<th align="left" valign="top" width="40%" id="d0e60">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLDESC</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>hdesc</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">Descriptor handle.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLINTEGER *</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>indic</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input (deferred)</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">INDICATOR_PTR field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLINTEGER *</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>sLen</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input (deferred)</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">LENGTH_PTR field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLINTEGER</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>length</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">LENGTH field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLPOINTER</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>data</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input (deferred)</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">DATA_PTR field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>irec</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">Record number within the descriptor.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>prec</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">PRECISION field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>scale</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">SCALE field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>subtype</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">DATETIME_INTERVAL_CODE field for records
|
||
|
|
whose TYPE is SQL_DATETIME.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="22.22222222222222%" headers="d0e54 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="21.296296296296298%" headers="d0e56 "><em>type</em></td>
|
||
|
|
<td align="left" valign="top" width="16.48148148148148%" headers="d0e58 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">TYPE field for the record.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Calling <samp class="codeph">SQLSetDescRec()</samp> sets
|
||
|
|
all the fields in a descriptor record in one call.</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>
|
||
|
|
</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. SQLSetDescRec SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e198">SQLSTATE</th>
|
||
|
|
<th align="left" valign="top" width="25%" id="d0e200">Description</th>
|
||
|
|
<th align="left" valign="top" width="50%" id="d0e202">Explanation</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e198 "><strong>HY</strong>009</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e200 ">Argument value that is not valid</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e202 ">The value specified for the argument <em>irec</em> is
|
||
|
|
less than 1. <p>A value that is not valid for another argument is specified.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e198 "><strong>HY</strong>016</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e200 ">Descriptor that is not valid</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e202 ">The descriptor handle referred to an implementation
|
||
|
|
row descriptor.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="25%" headers="d0e198 "><strong>HY</strong>021</td>
|
||
|
|
<td valign="top" width="25%" headers="d0e200 ">Internal descriptor that is not valid </td>
|
||
|
|
<td valign="top" width="50%" headers="d0e202 ">The internal descriptor cannot be addressed or allocated,
|
||
|
|
or it contains a value that is not valid.</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>
|