314 lines
8.2 KiB
HTML
314 lines
8.2 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>Edit (QECEDT) 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. -->
|
|
<!-- EDIT1H SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 at -->
|
|
<!-- RCHVMW2 on 26 Jan 1999 at 16:28:12 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File edited for tagging cleanup Oct 2001 by v2cdijab -->
|
|
<!--End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Edit (QECEDT) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
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="50%">Receiver variable</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Receiver variable length</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Source variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">*</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Source variable class</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Source variable precision</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Edit mask</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Edit mask length</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Zero balance fill character</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Edit (QECEDT) API uses an edit mask to transform a numeric from its
|
|
internal format to a character form suitable for displaying.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>Receives the edited output. The length of this area must be passed in the
|
|
receiver variable length parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Receiver variable length</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the referenced area by the receiver variable parameter. This
|
|
value must be greater than 0.</p>
|
|
|
|
<p>This value was returned in the receiver variable length parameter on the
|
|
previous call to the Convert Edit Code (QECCVTEC) API or Convert Edit Word
|
|
(QECCVTEW) API; otherwise, CPF27AF is returned.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Source variable</strong></dt>
|
|
|
|
<dd>INPUT; *
|
|
|
|
<p>The numeric value that is converted. The type is defined by the source
|
|
variable class parameter and the length is specified in the source variable
|
|
precision parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Source variable class</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The type of numeric variable passed in the source variable parameter.</p>
|
|
|
|
<p>The types are:</p>
|
|
|
|
<p> *BINARY<br>
|
|
*PACKED<br>
|
|
*ZONED</p>
|
|
</dd>
|
|
|
|
<dt><strong>Source variable precision</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The precision of the numeric variable specified in the source variable
|
|
parameter.</p>
|
|
|
|
<p>The value passed must be from 1 through 31.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="bottom">Variable<br>
|
|
Class</th>
|
|
<th align="left" valign="bottom">Precision</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Packed</em></td>
|
|
<td align="left" valign="top">The precision for which the variable was
|
|
declared. For example, PACKED(8,4) has precision 8.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Zoned</em></td>
|
|
<td align="left" valign="top">The precision for which the variable was
|
|
declared. For example, ZONED(8,4) has precision 8.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Binary(2)</em></td>
|
|
<td align="left" valign="top">5</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Binary(4)</em></td>
|
|
<td align="left" valign="top">10</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Some high-level languages limit the maximum precision
|
|
of packed and zoned numeric variables.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Edit mask</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The edit mask used for this edit operation. This is the value returned in
|
|
the edit mask parameter on the call to the QECCVTEC API or QECCVTEW API.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Edit mask length</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the edit mask. The value passed must be from 1 through 256.
|
|
This is the value returned in the edit mask length parameter on the call to the
|
|
QECCVTEC API or QECCVTEW API.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Zero balance fill character</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>Indicates how to perform the edit operation so that zero balance suppression
|
|
is done correctly for those edit codes that have zero balance suppression.</p>
|
|
|
|
<p>If the QECCVTEC API is used to create the edit mask, this should be the
|
|
value returned in the zero balance fill character parameter; otherwise,
|
|
unpredictable results may occur.</p>
|
|
|
|
<p>If the QECCVTEW API is used to create the edit mask, X'00' should be
|
|
specified for this parameter; otherwise, unpredictable results may occur.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF27AB E</td>
|
|
<td align="left" valign="top">Source variable class not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF27AF E</td>
|
|
<td align="left" valign="top">Edit mask not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF27B4 E</td>
|
|
<td align="left" valign="top">Source variable precision not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF27B7 E</td>
|
|
<td align="left" valign="top">Receiver variable length not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF27B8 E</td>
|
|
<td align="left" valign="top">Edit mask length not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V2R2
|
|
|
|
<hr>
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center">
|
|
<a href="#top_Of_Page">Top</a> |
|
|
<a href="edit1.htm">Edit Function APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|
|
|