ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/pase_sqloverrideccsid400.htm

143 lines
3.7 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>SQLOverrideCCSID400()--Override SQL CLI CCSID for i5/OS PASE</title>
<!-- Begin Header Records ========================================== -->
<!-- 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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Created by V2DCIJB on 23 Nov 1999 -->
<!-- Edited by Kersten Jan 02 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<h2>SQLOverrideCCSID400()--Override SQL CLI CCSID for i5/OS PASE</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;as400_protos.h&gt;
int SQLOverrideCCSID400(int <em>newCCSID</em>);
</pre>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Library: i5/OS PASE SQL CLI Library (libdb400.a)<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p><strong>Note:</strong> This function can only be used in an i5/OS PASE
program. See <a href="../rzalf/rzalfintro.htm">i5/OS PASE</a> for more
information about creating i5/OS PASE programs.</p>
<p>The <strong>SQLOverrideCCSID400()</strong> function allows an i5/OS PASE
program to specify a Coded Character Set Identifier (CCSID) used to convert
character data arguments and results on i5/OS PASE SQL Call Level Interface
(CLI) functions.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>newCCSID</strong></dt>
<dd>(Input) Specifies the CCSID used for i5/OS PASE SQL CLI functions.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>No special authorities required.</p>
<br>
<h3>Return Value</h3>
<p>The function result is zero for success, or -1 for an error that is further
qualified by an errno value.</p>
<br>
<h3>Error Conditions</h3>
<p>At least these errno values can be returned:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>[EINVAL]</em></td>
<td align="left" valign="top">The conversion between newCCSID and the i5/OS
job default CCSID is not supported.<br>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>[ENFILE]</em></td>
<td align="left" valign="top">A converter could not be opened because the
maximum number of files in the system are already opened.<br>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>[EMFILE]</em></td>
<td align="left" valign="top">A converter could not be opened because the
maximum number of files are already opened.</td>
</tr>
</table>
<br>
<br>
<h3>Usage Notes</h3>
<ol>
<li>The system automatically converts character arguments and results between
the CCSID of the job or database field and a CCSID used for i5/OS PASE SQL CLI
functions that defaults to the i5/OS PASE CCSID value in effect when the first
i5/OS PASE SQL CLI function is called. You must call SQLOverrideCCSID400
before any other i5/OS PASE SQL CLI function, or it will have no effect on
CCSID conversions.</li>
</ol>
<br>
<hr>
API introduced: V4R5
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"pase1.htm">i5/OS PASE APIs</a> | <a href="aplist.htm">APIs by category</a>
</td>
</tr>
</table>
</center>
</body>
</html>