109 lines
5.9 KiB
HTML
109 lines
5.9 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_StartWriter" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist4.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_startwriter" />
|
||
|
|
<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_StartWriter</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbobj_startwriter"><a name="cwbobj_startwriter"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">cwbOBJ_StartWriter</h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4> <p>Starts an iSeries™ writer job.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4> <pre>
|
||
|
|
unsigned int CWB_ENTRY cwbOBJ_StartWriter(
|
||
|
|
cwbOBJ_ObjHandle *printerHandle,
|
||
|
|
cwbOBJ_ObjHandle *outputQueueHandle,
|
||
|
|
cwbOBJ_ParmHandle *parmListHandle,
|
||
|
|
cwbOBJ_ObjHandle *writerHandle,
|
||
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4> <dl><dt class="dlterm">cwbOBJ_ObjHandle *printerHandle - input</dt>
|
||
|
|
<dd>Required. A pointer to a valid printer object handle that identifies
|
||
|
|
which printer this writer is to be started to.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ObjHandle *outputQueueHandle - input</dt>
|
||
|
|
<dd>Optional. A pointer to a valid output queue object handle that identifies
|
||
|
|
which output queue this writer is to be started from. If the parmListHandle
|
||
|
|
is also specified and contains the CWBOBJ_KEY_OUTQUE parameter key, this parameter
|
||
|
|
is ignored.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ParmHandle *parmListHandle - input</dt>
|
||
|
|
<dd>Optional. A pointer to a valid parameter list object handle that contains
|
||
|
|
parameters for starting the writer.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_ObjHandle *writerHandle - output</dt>
|
||
|
|
<dd>Optional. A pointer to a writer object handle that will be filled in
|
||
|
|
upon successful return from this API. If this parameter is specified, the
|
||
|
|
caller must call cwbOBJ_DeleteObjHandle() to release resources allocated for
|
||
|
|
this writer handle.</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 cwbSV_CreateErrHandle() API. The messages may be
|
||
|
|
retrieved through the cwbSV_GetErrText() 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">CWBOBJ_RC_HOST_ERROR</dt>
|
||
|
|
<dd>Host error occurred. Text may be in errorHandle.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4> <div class="p">Calling this API causes the writer job to
|
||
|
|
be submitted to run. The writer job may fail to start even though this API
|
||
|
|
returns successfully (the job may be successfully submitted, but fail to start).
|
||
|
|
This is the behavior of the STRPRTWTR command on the iSeries server. The following parameter
|
||
|
|
keys may be set in the parmListHandle object: <pre>CWBOBJ_KEY_ALIGN - Align page
|
||
|
|
CWBOBJ_KEY_ALWDRTPRT - Allow direct printing
|
||
|
|
CWBOBJ_KEY_AUTOEND - Automatically end writer (*YES,*NO)
|
||
|
|
CWBOBJ_KEY_DRWRSEP - Drawer to use for separators
|
||
|
|
CWBOBJ_KEY_FILESEP - Number of file separators
|
||
|
|
CWBOBJ_KEY_FORMTYPE - Name of the form to be used
|
||
|
|
CWBOBJ_KEY_JOBNAME - Name of the job that created file
|
||
|
|
CWBOBJ_KEY_JOBNUMBER - Number of the job that created file
|
||
|
|
CWBOBJ_KEY_USER - Name of the user that created file
|
||
|
|
CWBOBJ_KEY_FORMTYPEMSG - Form type message option
|
||
|
|
CWBOBJ_KEY_MSGQUELIB - Message queue library
|
||
|
|
CWBOBJ_KEY_MSGQUE - Message queue name
|
||
|
|
CWBOBJ_KEY_OUTQUELIB - Output queue library
|
||
|
|
CWBOBJ_KEY_OUTQUE - Output queue
|
||
|
|
CWBOBJ_KEY_SPOOLFILE - Spool file name
|
||
|
|
CWBOBJ_KEY_SPLFNUM - Spool file number
|
||
|
|
CWBOBJ_KEY_WTRSTRPAGE - Page to start the writer on
|
||
|
|
CWBOBJ_KEY_WTREND - When to end the writer
|
||
|
|
CWBOBJ_KEY_WRITER - Writer job name
|
||
|
|
CWBOBJ_KEY_WTRINIT - When to initialize the printer device</pre>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist4.htm" title="The following iSeries Access for Windows APIs pertain to Writer job. The APIs are listed alphabetically.">Writer job APIs for iSeries Access for Windows</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|