190 lines
11 KiB
HTML
190 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="Connection and statement attributes" />
|
||
|
|
<meta name="abstract" content="The ODBC specification defines several connection and statement attributes." />
|
||
|
|
<meta name="description" content="The ODBC specification defines several connection and statement attributes." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikodbcapifunctions.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="connstmtattr" />
|
||
|
|
<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>Connection and statement attributes</title>
|
||
|
|
</head>
|
||
|
|
<body id="connstmtattr"><a name="connstmtattr"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Connection and statement attributes</h1>
|
||
|
|
<div><p>The ODBC specification defines several connection and statement
|
||
|
|
attributes.</p>
|
||
|
|
<div class="section"><p>This ODBC specification is extended with several iSeries™ Access
|
||
|
|
for Windows<sup>®</sup> customized
|
||
|
|
attributes, that are described in the following 2 tables.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption>Table 1. Customized connection attributes</caption><thead align="left"><tr><th valign="top" width="11.76470588235294%" id="d0e30">Attribute</th>
|
||
|
|
<th valign="top" width="11.76470588235294%" id="d0e32">Get/Set</th>
|
||
|
|
<th valign="top" width="76.47058823529412%" id="d0e34">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">1204</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">An unsigned value that controls the cursor commit behavior
|
||
|
|
and cursor rollback behavior. Possible values: <ul><li>0 - SQL_CB_DELETE is returned for SQLGetInfo's SQL_CURSOR_COMMIT_BEHAVIOR
|
||
|
|
and SQL_CURSOR_ROLLBACK_BEHAVIOR options.</li>
|
||
|
|
<li>1 - (default) SQL_CB_PRESERVE is returned for SQLGetInfo's SQL _CURSOR_COMMIT_BEHAVIOR
|
||
|
|
and SQL_CURSOR_ROLLBACK_BEHAVIOR options.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2100</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">Can be used as an alternative to using the <span class="cmdname">DFTPKGLIB</span> connection
|
||
|
|
string keyword This is a character string that specifies the default package
|
||
|
|
library to be used. This should be set prior to preparing a statement on
|
||
|
|
this connection.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2101</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">This is a character string that specifies the package
|
||
|
|
name to be used. This should be set prior to preparing a statement on this
|
||
|
|
connection.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2103</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">get</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">Returns an unsigned integer value which is the server
|
||
|
|
CCSID value (job CCSID) that the ODBC connection is dealing with. By default,
|
||
|
|
SQL statements will be sent to the host in this CCSID</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2104</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">Can be used as an alternative to the Divide by zero
|
||
|
|
option of the DEBUG connection string keyword. This is an unsigned value
|
||
|
|
indicating whether or not dividing a value by zero should return an error
|
||
|
|
for data in a particular cell in the result set. Possible values: <ul><li> 0 - (default) A cell in a result set that contains a value calculated
|
||
|
|
by dividing by zero will be returned as an error.</li>
|
||
|
|
<li>1 - A cell in a result set that contains a value calculated by dividing
|
||
|
|
by zero will be returned as a NULL value. No error will be returned.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2106</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">An alternative to using the COMPRESSION connection string
|
||
|
|
keyword. This is an unsigned integer value. Possible values: <ul><li>0 = compression off</li>
|
||
|
|
<li>1 = compression on</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2109</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">set</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">An unsigned value specifying whether or not to trim
|
||
|
|
trailing spaces from data returned from CHAR fields. This will make CHAR
|
||
|
|
fields appear like VARCHAR fields as VARCHAR fields are always trimmed of
|
||
|
|
trailing spaces. Possible values: <ul><li>0 - (default) - don't trim CHAR fields</li>
|
||
|
|
<li>1 - trim CHAR fields</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2110</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">get</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">Returns a character string containing information about
|
||
|
|
the prestart job that the ODBC connection is using. The information is returned
|
||
|
|
as a string with the following format: <ul><li>10 character job name, </li>
|
||
|
|
<li>10 character user, </li>
|
||
|
|
<li>6 character job </li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 "><img src="./delta.gif" alt="Start of change" />2116<img src="./deltaend.gif" alt="End of change" /></td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 "><img src="./delta.gif" alt="Start of change" />set<img src="./deltaend.gif" alt="End of change" /></td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 "><img src="./delta.gif" alt="Start of change" />A pointer to a buffer containing the IBM<sup>®</sup> Enterprise
|
||
|
|
Workload Manager (eWLM) correlator. Specifying this attribute allows you to
|
||
|
|
tie your application with the eWLM support (<a href="../icbase/ewlminfo/eicaakickoff.htm" target="_blank">Enterprise Workload Manager</a>). <img src="./deltaend.gif" alt="End of change" /></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2140 </td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both </td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">An unsigned integer value that specifies the amount
|
||
|
|
of time (in seconds) that a distributed transaction waits before timing out.
|
||
|
|
A value of 0 indicates to wait indefinitely for the transaction to finish.
|
||
|
|
Setting this overrides any value that was set for the XATIMEOUT connection
|
||
|
|
string keyword. The default value for this attribute is 0.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2141 </td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">An unsigned integer value that specifies the maximum
|
||
|
|
amount of time (in seconds) that a distributed transaction waits on a lock
|
||
|
|
request before timing out. A value of 0 indicates to use the default system
|
||
|
|
settings. Setting this overrides any value that was set for the XALOCKTIMEOUT
|
||
|
|
connection string keyword. The default value for this attribute is 0. </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2142 </td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">both </td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 ">An integer value that specifies the RMID to use for
|
||
|
|
XA transaction work. This can be set at anytime. The RMID that is set must
|
||
|
|
be unique for the process. If this value is set to 0 it indicates that any
|
||
|
|
current XA transaction work has been completed for this connection. The default
|
||
|
|
value for this attribute is 0.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.76470588235294%" headers="d0e30 ">2143</td>
|
||
|
|
<td valign="top" width="11.76470588235294%" headers="d0e32 ">get</td>
|
||
|
|
<td valign="top" width="76.47058823529412%" headers="d0e34 "> A character string that identifies the iSeries Access
|
||
|
|
driver to call into for XA calls. This string is only valid if the 2142 connection
|
||
|
|
attribute has been set. This string is set after the connection is established.
|
||
|
|
The default value for this attribute is an empty-string.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption>Table 2. Customized statement attributes</caption><thead align="left"><tr><th valign="top" width="11.555555555555555%" id="d0e177">Attribute</th>
|
||
|
|
<th valign="top" width="12.444444444444445%" id="d0e179">Get/Set</th>
|
||
|
|
<th valign="top" width="76%" id="d0e181">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" width="11.555555555555555%" headers="d0e177 ">1014</td>
|
||
|
|
<td valign="top" width="12.444444444444445%" headers="d0e179 ">get</td>
|
||
|
|
<td valign="top" width="76%" headers="d0e181 ">Returns an unsigned integer value indicating how many
|
||
|
|
result sets are available to be fetched. This is useful when a stored procedure
|
||
|
|
has been called and an application wants to know how many result sets the
|
||
|
|
stored procedure generated. </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.555555555555555%" headers="d0e177 ">2106</td>
|
||
|
|
<td valign="top" width="12.444444444444445%" headers="d0e179 ">both</td>
|
||
|
|
<td valign="top" width="76%" headers="d0e181 ">Allows compression to be turned on an off at the statement
|
||
|
|
level. Possible values are: <ul><li>0 = compression off, </li>
|
||
|
|
<li>1 = compression on</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="11.555555555555555%" headers="d0e177 ">2114</td>
|
||
|
|
<td valign="top" width="12.444444444444445%" headers="d0e179 ">get</td>
|
||
|
|
<td valign="top" width="76%" headers="d0e181 ">Returns an unsigned integer value that indicates the
|
||
|
|
offset into a SQL statement at which a SQL syntax error has occurred. This
|
||
|
|
will be set when SQLExecute or SQLExecDirect returns an SQL_ERROR return code.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikodbcapifunctions.htm" title="Learn about implementations issues when using ODBC APIs.">Implementation issues of ODBC APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|