111 lines
6.2 KiB
HTML
111 lines
6.2 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="SQLAllocHandle - Allocate handle" />
|
||
|
|
<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="rzadpfnahdl" />
|
||
|
|
<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>SQLAllocHandle - Allocate handle</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzadpfnahdl"><a name="rzadpfnahdl"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">SQLAllocHandle - Allocate handle</h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLAllocHandle()</samp> allocates
|
||
|
|
any type of handle.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4> <pre>SQLRETURN SQLAllocHandle (SQLSMALLINT htype,
|
||
|
|
SQLINTEGER ihandle,
|
||
|
|
SQLINTEGER *handle);</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. SQLAllocHandle arguments</caption><thead align="left"><tr><th align="left" valign="bottom" width="20%" id="d0e52">Data type</th>
|
||
|
|
<th align="left" valign="bottom" width="20%" id="d0e54">Argument</th>
|
||
|
|
<th align="left" valign="bottom" width="20%" id="d0e56">Use</th>
|
||
|
|
<th align="left" valign="bottom" width="40%" id="d0e58">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="20%" headers="d0e52 ">SQLINTEGER *</td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e54 "><em>handle</em></td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e56 ">Output</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e58 ">Pointer to the handle.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="20%" headers="d0e52 ">SQLINTEGER</td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e54 "><em>ihandle</em></td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e56 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e58 ">The handle that describes the context in
|
||
|
|
which the new handle is allocated; however, if <em>htype</em> is SQL_HANDLE_ENV,
|
||
|
|
this is SQL_NULL_HANDLE.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="20%" headers="d0e52 ">SQLSMALLINT</td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e54 "><em>htype</em></td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e56 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e58 ">Type of handle to allocate. Must be either
|
||
|
|
SQL_HANDLE_ENV, SQL_HANDLE_DBC, SQL_HANDLE_DESC, or SQL_HANDLE_STMT.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4> <p>This function combines the functions of <samp class="codeph">SQLAllocEnv(),
|
||
|
|
SQLAllocConnect(),</samp> and <samp class="codeph">SQLAllocStmt()</samp>.</p>
|
||
|
|
<p>If <em>htype</em> is
|
||
|
|
SQL_HANDLE_ENV, <em>ihandle</em> must be SQL_NULL_HANDLE. If <em>htype</em> is
|
||
|
|
SQL_HANDLE_DBC, <em>ihandle</em> must be a valid environment handle. If <em>htype</em> is
|
||
|
|
either SQL_HANDLE_DESC or SQL_HANDLE_STMT, <em>ihandle</em> must be a valid
|
||
|
|
connection handle.</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><p>SQL_ERROR is returned if the argument
|
||
|
|
handle is a null pointer.</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="hsides" border="1" rules="rows"><caption>Table 2. SQLAllocHandle
|
||
|
|
SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="bottom" width="25%" id="d0e155">SQLSTATE</th>
|
||
|
|
<th align="left" valign="bottom" width="25%" id="d0e157">Description</th>
|
||
|
|
<th align="left" valign="bottom" width="50%" id="d0e159">Explanation</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e155 "><strong>58</strong>004</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e157 ">System error</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e159 ">Unrecoverable system error.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e155 "><strong>HY</strong>014</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e157 ">Too many handles</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e159 ">The maximum number of handles has been allocated.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">References</h4><ul><li><a href="rzadpfnacon.htm#rzadpfnacon">SQLAllocConnect - Allocate connection handle</a></li>
|
||
|
|
<li><a href="rzadpfnaenv.htm#rzadpfnaenv">SQLAllocEnv - Allocate environment handle</a></li>
|
||
|
|
<li><a href="rzadpfnastmt.htm#rzadpfnastmt">SQLAllocStmt - Allocate a statement handle</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>
|