ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbdtasciitopacked.htm

91 lines
4.4 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?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="cwbDT_ASCIIToPacked" />
<meta name="DC.Relation" scheme="URI" content="rzaikdatatransapilist.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="cwbdt_asciitopacked" />
<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>cwbDT_ASCIIToPacked</title>
</head>
<body id="cwbdt_asciitopacked"><a name="cwbdt_asciitopacked"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbDT_ASCIIToPacked</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Translates ASCII numeric data to packed
decimal format. This function can be used for translating ASCII text data
for use on the iSeries™ server.</p>
</div>
<div class="section"><h4 class="sectiontitle">Unicode version</h4><p><span class="apiname">cwbDT_WideToPacked</span></p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbDT_ASCIIToPacked(
char *target,
char *source,
unsigned long length,
unsigned long decimalPosition);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">char * target - output</dt>
<dd>Pointer to the target data.</dd>
<dt class="dlterm">char * source - input</dt>
<dd>Pointer to the source data. Must be zero terminated.</dd>
<dt class="dlterm">unsigned long length - input</dt>
<dd>Number of bytes of target data to translate.</dd>
<dt class="dlterm">unsigned long decimalPosition - input</dt>
<dd>Position of the decimal point.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
values.</p>
<dl><dt class="dlterm">CWB_OK</dt>
<dd>Successful Completion.</dd>
<dt class="dlterm">CWB_INVALID_POINTER</dt>
<dd>NULL pointer was passed by caller.</dd>
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
<dd>Overflow error.</dd>
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
<dd>Unable to allocate temporary memory.</dd>
<dt class="dlterm">other</dt>
<dd>Offset of the first untranslated character plus one.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The caller must make sure that there is adequate
space to hold the target information. The sign half-byte will be set to 0xd
to indicate a negative number and hex 0xc to indicate a positive number.
0 &lt;= decimalPosition &lt; (length * 2). Valid formats for the ASCII numeric
data are as follows: </p>
<ul><li>[blankspaces][sign][blankspaces][digits] or</li>
<li>[sign][blankspaces][digits][blankspaces] or</li>
<li>[sign][digits][.digits][blankspaces] or</li>
<li>[blankspaces][sign][digits][.digits][blankspaces]</li>
</ul>
</div>
<div class="example"><h4 class="sectiontitle">Examples: </h4><pre> " + 123\0"
"- 123 \0"
" +123 \0"
" 123\0"
" -12.3\0"
"+1.23 \0"</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikdatatransapilist.htm" title="The following data transformation APIs are listed alphabetically.">iSeries Access for Windows data transformation API list</a></div>
</div>
</div>
</body>
</html>