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

237 lines
6.3 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>Convert Character String to 64-Bit Integer (CEE4JSTN) API</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 -->
<!-- ILE5A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
<!-- RCHVMX on 25 Feb 1999 at 15:07:42 -->
<!-- Edited by Kersten Oct 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>Convert Character String to 64-Bit Integer (CEE4JSTN) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="TOP" width="10%">1</td>
<td align="LEFT" valign="TOP" width="30%">input_string</td>
<td align="LEFT" valign="TOP" width="30%">Input</td>
<td align="LEFT" valign="TOP" width="30%">VSTRING</td>
</tr>
<tr>
<td align="center" valign="TOP">2</td>
<td align="LEFT" valign="TOP">length</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">INT4</td>
</tr>
<tr>
<td align="center" valign="TOP">3</td>
<td align="LEFT" valign="TOP">output_integer</td>
<td align="LEFT" valign="TOP">output</td>
<td align="LEFT" valign="TOP">INT8</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="TOP" width="10%">5</td>
<td align="LEFT" valign="TOP" width="30%">fc</td>
<td align="LEFT" valign="TOP" width="30%">Output</td>
<td align="LEFT" valign="TOP" width="30%">FEEDBACK</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QLEMF<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Convert Character String to 64-Bit Integer (CEE4JSTN) API converts a
character string representation of an integer to its 64-bit integer
equivalent.</p>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>input_string (input)</strong></dt>
<dd>A character string representing the integer that needs to be formatted. The
valid range for signed integer is (-2<sup>63</sup>) &lt; x &lt; (2<sup>63</sup>
- 1). The range for unsigned is (0 &lt; x &lt; 2<sup>64</sup> - 1).
<p>The following rules apply to input_string.</p>
<p>The decimal separator is retrieved from the job attributes. The input string
is scanned left to right until the decimal point or end of string is reached.
Any character to the right of the decimal point will be ignored.</p>
<p>Multiple - and + are allowed. The first sign, starting from right to left
will indicate the sign of the input.</p>
<p>Imbedded spaces, "-", "+", "." and "," are valid characters.</p>
<p>For examples of this process, see <a href="#HDRCEEEX">API Examples</a>.</p>
</dd>
<dt><strong>length (input)</strong></dt>
<dd>A 32-bit binary integer representing the number of characters in the input
string provided including the sign.<br>
<br>
</dd>
<dt><strong>output_integer (output)</strong></dt>
<dd>A 64-bit storage in which the result is stored.</dd>
</dl>
<br>
<h3>Omissible Parameter</h3>
<dl>
<dt><strong>fc (output)</strong></dt>
<dd>A 12-byte feedback code passed by reference. If specified as an argument,
feedback information (a condition token) is returned to the calling procedure.
If not specified, and the requested operation was not successfully completed,
the condition is signaled to the condition manager.</dd>
</dl>
<br>
<h3>Feedback Codes and Conditions</h3>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="LEFT" valign="TOP">CEE0000</td>
<td align="LEFT" valign="TOP">The API completed successfully</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 00</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
<tr>
<td>CEE2537</td>
<td align="LEFT" valign="TOP">Intput string contains characters that are not
valid</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">CEE2539</td>
<td align="LEFT" valign="TOP">Intput integer is too large or too small</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
<tr>
<td>CEE9902</td>
<td align="LEFT" valign="TOP">Unexpected user error occurred in &amp;1</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
</table>
<br>
<h3><a name="HDRCEEEX">Examples</a></h3>
<p>In the following examples, "." is the decimal separator.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="LEFT" valign="TOP">Input</th>
<th align="LEFT" valign="TOP">Output</th>
</tr>
<tr>
<td align="LEFT" valign="TOP">" +241-"</td>
<td align="LEFT" valign="TOP">-241</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">" +1 001.23-"</td>
<td align="LEFT" valign="TOP">-1001</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">" 537,072.34+ "</td>
<td align="LEFT" valign="TOP">537072</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"ile1a1.htm">ILE CEE APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>