174 lines
9.1 KiB
HTML
174 lines
9.1 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_CreateNewSplF" />
|
||
|
|
<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_createnewsplf" />
|
||
|
|
<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_CreateNewSplF</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbobj_createnewsplf"><a name="cwbobj_createnewsplf"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbOBJ_CreateNewSplF</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Creates a new spooled file on the iSeries™ server.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbOBJ_CreateNewSplF(
|
||
|
|
const char *systemName,
|
||
|
|
cwbOBJ_ParmHandle *parmListHandle,
|
||
|
|
cwbOBJ_ObjHandle *printerFileHandle,
|
||
|
|
cwbOBJ_ObjHandle *outputQueueHandle,
|
||
|
|
cwbOBJ_ObjHandle *newSplFHandle,
|
||
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">const char *systemName - input</dt>
|
||
|
|
<dd>Pointer to the system name contained in ASCIIZ string</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ParmHandle *parmListHandle - input</dt>
|
||
|
|
<dd>Optional. A pointer to a valid parameter list object handle that contains
|
||
|
|
parameters for creating the spooled file. Parameters set in this list override
|
||
|
|
what is in the printer file and the *outputQueueHandle parameter.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ObjHandle *printerFileHandle - input</dt>
|
||
|
|
<dd>Optional. A pointer to a valid printer file object handle that references
|
||
|
|
the printer file to be used when creating this spooled file. The printer
|
||
|
|
file must exist on the same system that this spooled file is being created
|
||
|
|
on.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ObjHandle *outputQueueHandle - input</dt>
|
||
|
|
<dd>Optional. A pointer to a valid output queue object handle that references
|
||
|
|
the output queue that this spooled file should be created on. The output queue
|
||
|
|
must exist on the same system that this spooled file is being created on.
|
||
|
|
If the output queue is set in the *parmListHandle parameter (with CWBOBJ_KEY_OUTQUELIB &
|
||
|
|
CWBOBJ_KEY_OUTQUE) it will override the output queue specified by this output
|
||
|
|
queue handle.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ObjHandle *newSplFHandle - output</dt>
|
||
|
|
<dd>A pointer to a object handle that will be filled in upon successful completion
|
||
|
|
of this call with the newly created spooled file handle. This handle is needed
|
||
|
|
to write data into and close the new spooled file.</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</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_PARAMETER</dt>
|
||
|
|
<dd>Invalid parameter specified.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input Unicode characters have no representation in the codepage
|
||
|
|
being used.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p> If the parmListHandle is NULL, or doesn't
|
||
|
|
specify an attribute, the attribute is taken from the printer file used. If
|
||
|
|
the output queue is specified with the *parmListHandle, this will override
|
||
|
|
what is specified in the *outputQueueHandle parameter. If the output queue
|
||
|
|
is not specified (not in the *parmListHandle AND outputQueueHandle is NULL),
|
||
|
|
the output queue used is taken from the printer file. If the printer file
|
||
|
|
is not specified (printerFileHandle is NULL), the server will use the default
|
||
|
|
network print printer file, *LIBL/QNPSPRTF. The following parameter keys
|
||
|
|
may be set in the pParmListHandl object:</p>
|
||
|
|
<pre>CWBOBJ_KEY_ALIGN - Align page
|
||
|
|
CWBOBJ_KEY_BKOVRLLIB - Back overlay library name
|
||
|
|
CWBOBJ_KEY_BKOVRLAY - Back overlay
|
||
|
|
CWBOBJ_KEY_BKOVL_ACR - Back overlay offset across
|
||
|
|
CWBOBJ_KEY_BKOVL_DWN - Back overlay offset down
|
||
|
|
CWBOBJ_KEY_CPI - Characters Per Inch
|
||
|
|
(1)CWBOBJ_KEY_CODEPAGE - Code page
|
||
|
|
CWBOBJ_KEY_COPIES - Copies
|
||
|
|
CWBOBJ_KEY_DBCSDATA - Contains DBCS Data
|
||
|
|
CWBOBJ_KEY_DBCSEXTENSN - Process DBCS Extension
|
||
|
|
characters
|
||
|
|
CWBOBJ_KEY_DBCSROTATE - DBCS character rotation
|
||
|
|
CWBOBJ_KEY_DBCSCPI - DBCS CPI
|
||
|
|
CWBOBJ_KEY_DBCSSISO - DBCS SO/SI spacing
|
||
|
|
CWBOBJ_KEY_DFR_WRITE - Defer writing
|
||
|
|
CWBOBJ_KEY_ENDPAGE - Ending page
|
||
|
|
(2)CWBOBJ_KEY_FILESEP - File Separators
|
||
|
|
CWBOBJ_KEY_FOLDREC - Fold records
|
||
|
|
CWBOBJ_KEY_FONTID - Font identifier
|
||
|
|
CWBOBJ_KEY_FORMFEED - Form feed
|
||
|
|
CWBOBJ_KEY_FORMTYPE - Form type
|
||
|
|
CWBOBJ_KEY_FTOVRLLIB - Front overlay library name
|
||
|
|
CWBOBJ_KEY_FTOVRLAY - Front overlay
|
||
|
|
CWBOBJ_KEY_FTOVL_ACR - Front overlay offset across
|
||
|
|
CWBOBJ_KEY_FTOVL_DWN - Front overlay offset down
|
||
|
|
(1)CWBOBJ_KEY_CHAR_ID - Graphic character set ID
|
||
|
|
CWBOBJ_KEY_JUSTIFY - Hardware Justification
|
||
|
|
CWBOBJ_KEY_HOLD - Hold spooled file
|
||
|
|
CWBOBJ_KEY_LPI - Lines per inch
|
||
|
|
CWBOBJ_KEY_MAXRECORDS - Maximum spooled file records
|
||
|
|
CWBOBJ_KEY_OUTPTY - Output priority
|
||
|
|
CWBOBJ_KEY_OUTQUELIB - Output queue library name
|
||
|
|
CWBOBJ_KEY_OUTQUE - Output queue
|
||
|
|
CWBOBJ_KEY_OVERFLOW - Overflow line number
|
||
|
|
CWBOBJ_KEY_PAGELEN - Page length
|
||
|
|
CWBOBJ_KEY_MEASMETHOD - Measurement method
|
||
|
|
CWBOBJ_KEY_PAGEWIDTH - Page width
|
||
|
|
CWBOBJ_KEY_MULTIUP - Logical number of pages
|
||
|
|
per side
|
||
|
|
CWBOBJ_KEY_POINTSIZE - The default font's point size
|
||
|
|
CWBOBJ_KEY_FIDELITY - Print fidelity
|
||
|
|
CWBOBJ_KEY_DUPLEX - Print on both sides
|
||
|
|
CWBOBJ_KEY_PRTQUALITY - Print quality
|
||
|
|
CWBOBJ_KEY_PRTTEXT - Print text
|
||
|
|
CWBOBJ_KEY_PRINTER - Printer device name
|
||
|
|
CWBOBJ_KEY_PRTDEVTYPE - Printer device type
|
||
|
|
CWBOBJ_KEY_RPLUNPRT - Replace unprintable characters
|
||
|
|
CWBOBJ_KEY_RPLCHAR - Replacement character
|
||
|
|
CWBOBJ_KEY_SAVESPLF - Save spooled file after
|
||
|
|
printing
|
||
|
|
CWBOBJ_KEY_SRCDRWR - Source drawer
|
||
|
|
CWBOBJ_KEY_SPOOL - Spool the data
|
||
|
|
CWBOBJ_KEY_SPOOLFILE - Spool file name
|
||
|
|
CWBOBJ_KEY_SCHEDULE - When spooled file available
|
||
|
|
CWBOBJ_KEY_STARTPAGE - Starting page
|
||
|
|
CWBOBJ_KEY_UNITOFMEAS - Unit of measure
|
||
|
|
CWBOBJ_KEY_USERCMT - User comment (100 chars)
|
||
|
|
CWBOBJ_KEY_USERDATA - User data (10 chars)
|
||
|
|
CWBOBJ_KEY_SPLSCS - Spool SCS Data
|
||
|
|
CWBOBJ_KEY_USRDFNDTA - User defined data
|
||
|
|
(3)CWBOBJ_KEY_USRDFNOPTS - User defined options
|
||
|
|
CWBOBJ_KEY_USRDFNOBJLIB - User defined object library
|
||
|
|
CWBOBJ_KEY_USRDFNOBJ - User defined object
|
||
|
|
CWBOBJ_KEY_USRDFNOBJTYP - User defined object type</pre>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> <ol><li>Code page and graphic character set are dependent on each other. If you
|
||
|
|
specify one of these, you must specify the other.</li>
|
||
|
|
<li>The special value of *FILE is not allowed when using this attribute to
|
||
|
|
create a new spooled file.</li>
|
||
|
|
<li>Up to 4 user defined options may be specified.</li>
|
||
|
|
</ol>
|
||
|
|
</div>
|
||
|
|
</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>
|