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

85 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_CallExitPgmForSplF" />
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist9.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_callexitpgmforsplf" />
<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_CallExitPgmForSplF</title>
</head>
<body id="cwbobj_callexitpgmforsplf"><a name="cwbobj_callexitpgmforsplf"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbOBJ_CallExitPgmForSplF</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Instructs the iSeries™ Access Netprint server program,
QNPSERVR, to call down its exit program chain passing this spooled file's
ID and some application specified data as parameters.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbOBJ_CallExitPgmForSplF(
cwbOBJ_ObjHandle splFHandle,
void *data,
unsigned long dataLen,
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbOBJ_ObjHandle splFHandle - input</dt>
<dd>Handle of the spooled file to be passes as a parameter to the exit programs.</dd>
<dt class="dlterm">void *data - input</dt>
<dd>Pointer to a block of date that will be passed to the exit programs.
The format of this data is exit program specific.</dd>
<dt class="dlterm">unsigned long dataLen - input</dt>
<dd>length of data pointed to by pData.</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_INVALID_TYPE</dt>
<dd>Handle is not a spooled file handle.</dd>
<dt class="dlterm">CWBOBJ_RC_NO_EXIT_PGM</dt>
<dd> No exit program is registered with the Network Print server.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This is a way for a client program to communicate
with its server portion to do processing of spooled files. All exit programs
registered with the QNPSERVR program on the iSeries server will be called, so it
is up to the client program and exit program to architect the format of the
data in *data such that the exit program can recognize it. See the iSeries server
'Guide to Programming for Print' for information on the interface between
the QNPSERVR server program and the exit programs.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist9.htm" title="The following iSeries Access for Windows APIs pertain to manipulating spooled files. The APIs are listed alphabetically.">APIs for manipulating spooled files for iSeries Access for Windows</a></div>
</div>
</div>
</body>
</html>