95 lines
5.0 KiB
HTML
95 lines
5.0 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="cwbNL_Convert" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikconvnlsapis.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="cwbnl_convert" />
|
|
<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>cwbNL_Convert</title>
|
|
</head>
|
|
<body id="cwbnl_convert"><a name="cwbnl_convert"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">cwbNL_Convert</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Convert strings by using a previously opened
|
|
converter.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY cwbNL_Convert(
|
|
cwbNL_Converter theConverter,
|
|
unsigned long sourceLength,
|
|
unsigned long targetLength,
|
|
char *sourceBuffer,
|
|
char *targetBuffer,
|
|
unsigned long *numberOfErrors,
|
|
unsigned long *firstErrorIndex,
|
|
unsigned long *requiredLen,
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbNL_Converter theConverter - output</dt>
|
|
<dd>Handle to the previously opened converter.</dd>
|
|
<dt class="dlterm">unsigned long sourceLength - input</dt>
|
|
<dd>Length of the source buffer.</dd>
|
|
<dt class="dlterm">unsigned long targetLength - input</dt>
|
|
<dd>Length of the target buffer. If converting from an ASCII code page that
|
|
contains DBCS characters, note that the resulting data could contain shift-out
|
|
and shift-in bytes. Therefore, the targetBuffer may need to be larger than
|
|
the sourceBuffer.</dd>
|
|
<dt class="dlterm">char *sourceBuffer - input</dt>
|
|
<dd>Buffer containing the data to convert.</dd>
|
|
<dt class="dlterm">char *targetBuffer - output</dt>
|
|
<dd>Buffer to contain the converted data.</dd>
|
|
<dt class="dlterm">unsigned long *numberOfErrors - output</dt>
|
|
<dd>Contains the number of characters that could not be converted properly.</dd>
|
|
<dt class="dlterm">unsigned long *firstErrorIndex - output</dt>
|
|
<dd>Contains the offset of the first character in the source buffer that could
|
|
not be converted properly.</dd>
|
|
<dt class="dlterm">unsigned long *requiredLen - output</dt>
|
|
<dd>Actual length of the result. If requiredLen > resultLen, the return
|
|
value will be CWB_BUFFER_OVERFLOW.</dd>
|
|
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
|
|
<dd>Handle to an error object. Any returned messages will be written to this
|
|
object. It is created with the <span class="apiname">cwbSV_CreateErrHandle</span> API.
|
|
The messages may be retrieved with the <span class="apiname">cwbSV_GetErrText</span> API.
|
|
If the parameter is set to zero, no messages will be retrievable.</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_HANDLE</dt>
|
|
<dd>Invalid handle.</dd>
|
|
<dt class="dlterm">CWB_INVALID_POINTER</dt>
|
|
<dd>NULL passed on output parameter.</dd>
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
|
<dd>Insufficient memory.</dd>
|
|
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
|
|
<dd>Output buffer too small, data truncated.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>None</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikconvnlsapis.htm" title="This topic describes the iSeries Access for Windows conversion NLS APIs.">iSeries Access for Windows conversion NLS APIs list</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |