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

73 lines
4.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="cwbOBJ_AnalyzeSplFData" />
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist11.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="cwbobj_analyzesplfdata" />
<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>cwbOBJ_AnalyzeSplFData</title>
</head>
<body id="cwbobj_analyzesplfdata"><a name="cwbobj_analyzesplfdata"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbOBJ_AnalyzeSplFData</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Analyze data for a spooled file and give
a best guess as to what the data type is.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbOBJ_AnalyzeSplFData(
const char *data,
unsigned long bufLen,
cwbOBJ_SplFDataType *dataType,
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">const char *data - input</dt>
<dd>pointer to data to be analyzed.</dd>
<dt class="dlterm">unsigned long bufLen - input</dt>
<dd>The length of the buffer pointed to by data.</dd>
<dt class="dlterm">cwbOBJ_SplFDataType *dataType - output</dt>
<dd>On output this will contain the data type. If the data type can not be
determined, it defaults to CWBOBJ_DT_USERASCII.</dd>
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
<dd>Optional, may be 0. 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 through 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_PARAMETER</dt>
<dd>Invalid parameter specified.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This uses the same routine that
is used during the creation of spooled files that don't have a data type specified
or have a data type of *AUTO specified. The result defaults to *USERASCII
if it can not be determined.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist11.htm" title="The following iSeries Access for Windows APIs pertain to analyzing spooled file data. The APIs are listed alphabetically.">APIs for analyzing spooled file data for iSeries Access for Windows</a></div>
</div>
</div>
</body>
</html>