friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.cli_5.4.0.1/rzadpfngfunc.htm

253 lines
12 KiB
HTML
Raw Permalink Blame History

<?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="SQLGetFunctions - Get functions" />
<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="rzadpfngfunc" />
<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>SQLGetFunctions</title>
</head>
<body id="rzadpfngfunc"><a name="rzadpfngfunc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">SQLGetFunctions - Get functions</h1>
<div><div class="section"></div>
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLGetFunctions()</samp> queries
whether a specific function is supported. This allows applications to adapt
to varying levels of support when using different drivers.</p>
<p><samp class="codeph">SQLConnect()</samp> must
be called, and a connection to the data source (database server) must exist
before calling this function.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLGetFunctions (SQLHDBC hdbc,
SQLSMALLINT fFunction,
SQLSMALLINT *pfSupported);</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. SQLGetFunctions arguments</caption><thead align="left"><tr><th align="left" valign="top" width="22.77777777777778%" id="d0e52">Data type</th>
<th align="left" valign="top" width="20%" id="d0e54">Argument</th>
<th align="left" valign="top" width="17.22222222222222%" id="d0e56">Use</th>
<th align="left" valign="top" width="40%" id="d0e58">Description</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="22.77777777777778%" headers="d0e52 ">SQLHDBC</td>
<td align="left" valign="top" width="20%" headers="d0e54 "><em>hdbc</em></td>
<td align="left" valign="top" width="17.22222222222222%" headers="d0e56 ">Input</td>
<td align="left" valign="top" width="40%" headers="d0e58 ">Database connection handle.</td>
</tr>
<tr><td align="left" valign="top" width="22.77777777777778%" headers="d0e52 ">SQLSMALLINT *</td>
<td align="left" valign="top" width="20%" headers="d0e54 "><em>pfSupported</em></td>
<td align="left" valign="top" width="17.22222222222222%" headers="d0e56 ">Output</td>
<td align="left" valign="top" width="40%" headers="d0e58 ">Pointer to location where this function returns
SQL_TRUE or SQL_FALSE depending on whether the function being queried is supported.</td>
</tr>
<tr><td align="left" valign="top" width="22.77777777777778%" headers="d0e52 ">SQLSMALLINT</td>
<td align="left" valign="top" width="20%" headers="d0e54 "><em>fFunction</em></td>
<td align="left" valign="top" width="17.22222222222222%" headers="d0e56 ">Input</td>
<td align="left" valign="top" width="40%" headers="d0e58 ">Function being queried.</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The following list shows the valid for the <em>fFunction</em> argument
and whether the corresponding function is supported. Note that the values
marked with an asterisk are not supported when connected to a remote server.</p>
<div class="p"><pre>SQL_API_ALLOCCONNECT = TRUE
SQL_API_ALLOCENV = TRUE
SQL_API_ALLOCHANDLE = TRUE
SQL_API_ALLOCSTMT = TRUE
SQL_API_BINDCOL = TRUE
SQL_API_BINDFILETOCOL = TRUE
SQL_API_BINDFILETOPARAM = TRUE
SQL_API_BINDPARAM = TRUE
SQL_API_BINDPARAMETER = TRUE
SQL_API_CANCEL = TRUE
SQL_API_CLOSECURSOR = TRUE
SQL_API_COLATTRIBUTES = TRUE
SQL_API_COLUMNS = TRUE
SQL_API_CONNECT = TRUE
SQL_API_COPYDESC = TRUE
SQL_API_DATASOURCES = TRUE
SQL_API_DESCRIBECOL = TRUE
SQL_API_DESCRIBEPARAM = TRUE
SQL_API_DISCONNECT = TRUE
SQL_API_DRIVERCONNECT = TRUE
SQL_API_ENDTRAN = TRUE
SQL_API_ERROR = TRUE
SQL_API_EXECDIRECT = TRUE
SQL_API_EXECUTE = TRUE
SQL_API_EXTENDEDFETCH = TRUE
SQL_API_FETCH = TRUE
SQL_API_FOREIGNKEYS = TRUE
SQL_API_FREECONNECT = TRUE
SQL_API_FREEENV = TRUE
SQL_API_FREEHANDLE = TRUE
SQL_API_FREESTMT = TRUE
SQL_API_GETCOL = TRUE
SQL_API_GETCONNECTATTR = TRUE
SQL_API_GETCONNECTOPTION = TRUE
SQL_API_GETCURSORNAME = TRUE
SQL_API_GETDATA = TRUE
SQL_API_GETDESCFIELD = TRUE
SQL_API_GETDESCREC = TRUE
SQL_API_GETDIAGFIELD = TRUE
SQL_API_GETDIAGREC = TRUE
SQL_API_GETENVATTR = TRUE
SQL_API_GETFUNCTIONS = TRUE
SQL_API_GETINFO = TRUE
SQL_API_GETLENGTH = TRUE
SQL_API_GETPOSITION = TRUE
SQL_API_GETSTMTATTR = TRUE
SQL_API_GETSTMTOPTION = TRUE
SQL_API_GETSUBSTRING = TRUE
SQL_API_GETTYPEINFO = TRUE
SQL_API_LANGUAGES = TRUE
SQL_API_MORERESULTS = TRUE
SQL_API_NATIVESQL = TRUE
SQL_API_NUMPARAMS = TRUE
SQL_API_NUMRESULTCOLS = TRUE
SQL_API_PARAMDATA = TRUE
SQL_API_PARAMOPTIONS = TRUE
SQL_API_PREPARE = TRUE
SQL_API_PRIMARYKEYS = TRUE
SQL_API_PROCEDURECOLUMNS = TRUE
SQL_API_PROCEDURES = TRUE
SQL_API_PUTDATA = TRUE
SQL_API_RELEASEENV = TRUE
SQL_API_ROWCOUNT = TRUE
SQL_API_SETCONNECTATTR = TRUE
SQL_API_COLATTRIBUTES = TRUE
SQL_API_COLUMNS = TRUE
SQL_API_CONNECT = TRUE
SQL_API_COPYDESC = TRUE
SQL_API_DATASOURCES = TRUE
SQL_API_DESCRIBECOL = TRUE
SQL_API_DESCRIBEPARAM = TRUE
SQL_API_DISCONNECT = TRUE
SQL_API_DRIVERCONNECT = TRUE
SQL_API_ENDTRAN = TRUE
SQL_API_ERROR = TRUE
SQL_API_EXECDIRECT = TRUE
SQL_API_EXECUTE = TRUE
SQL_API_EXTENDEDFETCH = TRUE
SQL_API_FETCH = TRUE
SQL_API_FOREIGNKEYS = TRUE
SQL_API_FREECONNECT = TRUE
SQL_API_FREEENV = TRUE
SQL_API_FREEHANDLE = TRUE
SQL_API_FREESTMT = TRUE
SQL_API_GETCOL = TRUE
SQL_API_GETCONNECTATTR = TRUE
SQL_API_GETCONNECTOPTION = TRUE
SQL_API_GETCURSORNAME = TRUE
SQL_API_GETDATA = TRUE
SQL_API_GETDESCFIELD = TRUE
SQL_API_GETDESCREC = TRUE
SQL_API_GETDIAGFIELD = TRUE
SQL_API_GETDIAGREC = TRUE
SQL_API_GETENVATTR = TRUE
SQL_API_GETFUNCTIONS = TRUE
SQL_API_GETINFO = TRUE
SQL_API_GETLENGTH = TRUE
SQL_API_GETPOSITION = TRUE
SQL_API_GETSTMTATTR = TRUE
SQL_API_GETSTMTOPTION = TRUE
SQL_API_GETSUBSTRING = TRUE
SQL_API_GETTYPEINFO = TRUE
SQL_API_LANGUAGES = TRUE
SQL_API_MORERESULTS = TRUE
SQL_API_NATIVESQL = TRUE
SQL_API_NUMPARAMS = TRUE
SQL_API_NUMRESULTCOLS = TRUE
SQL_API_PARAMDATA = TRUE
SQL_API_PARAMOPTIONS = TRUE
SQL_API_PREPARE = TRUE
SQL_API_PRIMARYKEYS = TRUE
SQL_API_PROCEDURECOLUMNS = TRUE
SQL_API_PROCEDURES = TRUE
SQL_API_PUTDATA = TRUE
SQL_API_RELEASEENV = TRUE
SQL_API_ROWCOUNT = TRUE
SQL_API_SETCONNECTATTR = TRUE
SQL_API_SETCONNECTOPTION = TRUE
SQL_API_SETCURSORNAME = TRUE
SQL_API_SETDESCFIELD = TRUE
SQL_API_SETDESCREC = TRUE
SQL_API_SETENVATTR = TRUE
SQL_API_SETPARAM = TRUE
SQL_API_SETSTMTATTR = TRUE
SQL_API_SETSTMTOPTION = TRUE
SQL_API_SPECIALCOLUMNS = TRUE *
SQL_API_STATISTICS = TRUE *
SQL_API_TABLES = TRUE
SQL_API_TRANSACT = TRUE</pre>
</div>
</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. SQLGetFunctions SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e127">SQLSTATE</th>
<th align="left" valign="top" width="25%" id="d0e129">Description</th>
<th align="left" valign="top" width="50%" id="d0e131">Explanation</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e127 "><strong>40</strong>003 <strong>*</strong></td>
<td align="left" valign="top" width="25%" headers="d0e129 ">Statement completion unknown</td>
<td align="left" valign="top" width="50%" headers="d0e131 ">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="d0e127 "><strong>58</strong>004</td>
<td align="left" valign="top" width="25%" headers="d0e129 ">System error</td>
<td align="left" valign="top" width="50%" headers="d0e131 ">Unrecoverable system error.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e127 "><strong>HY</strong>001</td>
<td align="left" valign="top" width="25%" headers="d0e129 ">Memory allocation failure</td>
<td align="left" valign="top" width="50%" headers="d0e131 ">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="d0e127 "><strong>HY</strong>009</td>
<td align="left" valign="top" width="25%" headers="d0e129 ">Argument value that is not valid.</td>
<td align="left" valign="top" width="50%" headers="d0e131 ">The argument <em>pfSupported</em> is a null
pointer.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e127 "><strong>HY</strong>010</td>
<td align="left" valign="top" width="25%" headers="d0e129 ">Function sequence error. Connection handles
must not be allocated yet.</td>
<td align="left" valign="top" width="50%" headers="d0e131 ">SQLGetFunctions is called before SQLConnect.</td>
</tr>
<tr><td align="left" valign="top" width="25%" headers="d0e127 "><strong>HY</strong>013 <strong>*</strong></td>
<td align="left" valign="top" width="25%" headers="d0e129 ">Memory management problem</td>
<td align="left" valign="top" width="50%" headers="d0e131 ">The driver is unable to access memory required
to support the processing or completion of the function.</td>
</tr>
</tbody>
</table>
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink