84 lines
4.8 KiB
HTML
84 lines
4.8 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_GetSplFHandleFromNewSplF" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist7.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_getsplfhandlefromnewsplf" />
|
|
<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_GetSplFHandleFromNewSplF</title>
|
|
</head>
|
|
<body id="cwbobj_getsplfhandlefromnewsplf"><a name="cwbobj_getsplfhandlefromnewsplf"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">cwbOBJ_GetSplFHandleFromNewSplF</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Uses a new spooled file handle to generate
|
|
a spooled file handle. See notes below about using this API on a new spool
|
|
file that was created with data type automatic.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY cwbOBJ_GetSplFHandleFromNewSplF(
|
|
cwbOBJ_ObjHandle newSplFHandle,
|
|
cwbOBJ_ObjHandle *splFHandle,
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbOBJ_ObjHandle newSplFHandle - input</dt>
|
|
<dd>New spooled file handle. This is the handle passed back on the <span class="apiname">cwbOBJ_CreateNewSplF()</span> API.</dd>
|
|
<dt class="dlterm">cwbOBJ_ObjHandle *splFHandle - output</dt>
|
|
<dd>Pointer to an object handle that, upon successful completion of this call,
|
|
will hold the spooled file handle. This handle may be used with other APIs
|
|
that take a spooled file handle as input.</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_NO_ERROR</dt>
|
|
<dd>Successful completion.</dd>
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
|
<dd>Insufficient memory.</dd>
|
|
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
|
|
<dd>Handle is not valid spooled file handle.</dd>
|
|
<dt class="dlterm">CWBOBJ_RC_HOST_ERROR</dt>
|
|
<dd>Host error occurred. Text may be in errorHandle.</dd>
|
|
<dt class="dlterm">CWBOBJ_RC_SPLFNOTOPEN</dt>
|
|
<dd>Spooled file hasn't been created on the host yet.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The handle returned in splFHandle must be
|
|
released with the <span class="apiname">cwbOBJ_DeleteObjHandle()</span> API in order
|
|
to free resources.</p>
|
|
<p>If you are using automatic data typing for the spooled
|
|
file (the attribute of CWBOBJ_KEY_PRTDEVTYPE was set to *AUTO or or wasn't
|
|
specified on the <span class="apiname">cwbOBJ_CreateNewSplF()</span> API)
|
|
then creation of the spooled file will be delayed until sufficient data has
|
|
been written to the spooled file to determine the type of the data (*SCS,
|
|
*AFPDS or *USERASCII). If the new spooled file is in this state when you
|
|
call this API, the return code will be CWBOBJ_RC_SPLFNOTOPEN.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist7.htm" title="The following iSeries Access for Windows APIs pertain to working with new spooled files. The APIs are listed alphabetically.">APIs for new spooled files for iSeries Access for Windows</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |