friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaiksoaattrspecvaluprinters.htm

421 lines
19 KiB
HTML
Raw Permalink Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?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="Printer attributes" />
<meta name="abstract" content="System Object Access uses iSeries APIs to retrieve attributes for printer objects." />
<meta name="description" content="System Object Access uses iSeries APIs to retrieve attributes for printer objects." />
<meta name="DC.Relation" scheme="URI" content="rzaiksoaattrspecvalu.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="soaattrspecvaluprinters" />
<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>Printer attributes</title>
</head>
<body id="soaattrspecvaluprinters"><a name="soaattrspecvaluprinters"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Printer attributes</h1>
<div><p>System Object Access uses iSeries™ APIs to retrieve attributes for
printer objects.</p>
<div class="section"><p>A printer is a “logical” object that is actually a combination
of a device description, a writer, and an output queue. The attributes and
their possible values are as follows.</p>
</div>
<div class="section"> <dl><dt class="dlterm">CWBSO_PRT_AdvancedFunctionPrinting</dt>
<dd>Whether the printer device supports Advanced Function Printing™ (AFP™).
<dl><dt class="dlterm">*NO</dt>
<dd>The printer device does not support Advanced Function Printing.</dd>
<dt class="dlterm">*YES</dt>
<dd>The printer device supports Advanced Function Printing.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_AllowDirectPrinting</dt>
<dd>Whether the printer writer allows the printer to be allocated to a job
that prints directly to a printer. <dl><dt class="dlterm">*NO</dt>
<dd>Direct printing is not allowed</dd>
<dt class="dlterm">*YES</dt>
<dd>Direct printing is allowed.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_BetweenCopiesStatus</dt>
<dd>Whether the writer is between copies of a multiple copy spooled file.
The possible values are Y (yes) or N (no).</dd>
<dt class="dlterm">CWBSO_PRT_BetweenFilesStatus</dt>
<dd>Whether the writer is between spooled files. The possible values are Y
(yes) or N (no).</dd>
<dt class="dlterm">CWBSO_PRT_ChangesTakeEffect</dt>
<dd>The time at which the pending changes to the writer take effect. Possible
values are: <dl><dt class="dlterm">*NORDYF</dt>
<dd>When all the current eligible files are printed.</dd>
<dt class="dlterm">*FILEEND</dt>
<dd>When the current spooled file is done printing.</dd>
<dt class="dlterm">blank</dt>
<dd>No pending changes to the writer.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_CopiesLeftToProduce</dt>
<dd>The number of copies that are left to be printed. This field is set to
0 when no file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_CurrentPage</dt>
<dd>The page number in the spooled file that the writer is currently processing.
The page number shown may be lower or higher than the actual page number
being printed because of buffering done by the system. This field is set
to 0 when no spooled file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_Description</dt>
<dd>The text description of the printer device.</dd>
<dt class="dlterm">CWBSO_PRT_DeviceName</dt>
<dd>The name of the printer device.</dd>
<dt class="dlterm">CWBSO_PRT_DeviceStatus</dt>
<dd>The status of the printer device. Possible values are the same as the
device status that is returned by the <span class="apiname">Retrieve Configuration Status
(QDCRCFGS)</span> API.</dd>
<dt class="dlterm">CWBSO_PRT_EndAutomatically</dt>
<dd>When to end the writer if it is to end automatically. <dl><dt class="dlterm">*NORDYF</dt>
<dd>When no files are ready to print on the output queue from which the writer
is selecting files to be printed.</dd>
<dt class="dlterm">*FILEEND</dt>
<dd>When the current spooled file has been printed.</dd>
<dt class="dlterm">*NO</dt>
<dd>The writer will not end, but it will wait for more spooled files.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_EndPendingStatus</dt>
<dd>Whether an <span class="cmdname">End Writer (ENDWTR)</span> command has been issued
for this writer. Possible values are: <dl><dt class="dlterm">N</dt>
<dd>No ENDWTR command was issued.</dd>
<dt class="dlterm">I</dt>
<dd>*IMMED: The writer ends as soon as its output buffers are empty.</dd>
<dt class="dlterm">C</dt>
<dd>*CNTRLD: The writer ends after the current copy of the spooled file has
been printed.</dd>
<dt class="dlterm">P</dt>
<dd>*PAGEEND: The writer ends at the end of the page.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_FileName</dt>
<dd>The name of the spooled file that the writer is currently processing.
This field is blank when no file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_FileNumber</dt>
<dd>The number of the spooled file that the writer is currently processing.
This field is set to 0 when no spooled file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_FormsAlignment</dt>
<dd>The time at which the forms alignment message will be sent. Possible values
are: <dl><dt class="dlterm">*WTR</dt>
<dd>The writer determines when the message is sent.</dd>
<dt class="dlterm">*FILE</dt>
<dd>Control of the page alignment is specified by each file.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_FormType</dt>
<dd>The type of form that is being used to print the spooled file. Possible
values are: <dl><dt class="dlterm">*ALL</dt>
<dd>The writer is started with the option to print all spooled files of any
form type.</dd>
<dt class="dlterm">*FORMS</dt>
<dd>The writer is started with the option to print all the spooled files with
the same form type before using a different form type.</dd>
<dt class="dlterm">*STD</dt>
<dd>The writer is started with the option to print all the spooled files with
a form type of *STD.</dd>
<dt class="dlterm">form type name</dt>
<dd>The writer is started with the option to print all the spooled files with
the form type you specified.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_FormTypeNotification</dt>
<dd>Message option for sending a message to the message queue when this form
is finished. Possible values are: <dl><dt class="dlterm">*MSG</dt>
<dd>A message is sent to the message queue.</dd>
<dt class="dlterm">*NOMSG</dt>
<dd>No message is sent to the message queue.</dd>
<dt class="dlterm">*INFOMSG</dt>
<dd>An informational message is sent to the message queue.</dd>
<dt class="dlterm">*INQMSG</dt>
<dd>An inquiry message is sent to the message queue.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_HeldStatus</dt>
<dd>Whether the writer is held. The possible values are Y (yes) or N (no).</dd>
<dt class="dlterm">CWBSO_PRT_HoldPendingStatus</dt>
<dd>Whether a <span class="cmdname">Hold Writer (HLDWTR)</span> command has been issued
for this writer. Possible values are: <dl><dt class="dlterm">N</dt>
<dd>No HLDWTR command was issued.</dd>
<dt class="dlterm">I</dt>
<dd>*IMMED: The writer is held as soon as its output buffers are empty.</dd>
<dt class="dlterm">C</dt>
<dd>*CNTRLD: The writer is held after the current copy of the file has been
printed.</dd>
<dt class="dlterm">P</dt>
<dd>*PAGEEND: The writer is held at the end of the page.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_JobName</dt>
<dd>The name of the job that created the spooled file which the writer is
currently processing. This field is blank when no spooled file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_JobNumber</dt>
<dd>The number of the job that created the spooled file which the writer currently
is processing. This field is blank when no spooled file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_MessageKey</dt>
<dd>The key to the message that the writer is waiting for a reply. This field
will be blank when the writer is not waiting for a reply to an inquiry message.</dd>
<dt class="dlterm">CWBSO_PRT_MessageQueueLibrary</dt>
<dd>The name of the library that contains the message queue.</dd>
<dt class="dlterm">CWBSO_PRT_MessageQueueName</dt>
<dd>The name of the message queue that this writer uses for operational messages.</dd>
<dt class="dlterm">CWBSO_PRT_MessageWaitingStatus</dt>
<dd>Whether the writer is waiting for a reply to an inquiry message. The
possible values are Y (yes) or N (no).</dd>
<dt class="dlterm">CWBSO_PRT_NextFormType</dt>
<dd>The name of the next form type to be printed. Possible values are: <dl><dt class="dlterm">*ALL</dt>
<dd>The writer is changed with the option to print all spooled files of any
form type.</dd>
<dt class="dlterm">*FORMS</dt>
<dd>The writer is changed with the option to print all the spooled files with
the same form type before using a different form type.</dd>
<dt class="dlterm">*STD</dt>
<dd>The writer is changed with the option to print all the spooled files with
a form type of *STD.</dd>
<dt class="dlterm">form type name</dt>
<dd>The writer is changed with the option to print all the spooled files with
the form type name you specified.</dd>
<dt class="dlterm">blank</dt>
<dd>No change has been made to this writer.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_NextFormTypeNotification</dt>
<dd>The message option for sending a message to the message queue when the
next form type is finished. Possible values are: <dl><dt class="dlterm">*MSG</dt>
<dd>A message is sent to the message queue.</dd>
<dt class="dlterm">*NOMSG</dt>
<dd>No message is sent to the message queue.</dd>
<dt class="dlterm">*INFOMSG</dt>
<dd>An informational message is sent to the message queue.</dd>
<dt class="dlterm">*INQMSG</dt>
<dd>An inquiry message is sent to the message queue.</dd>
<dt class="dlterm">blank</dt>
<dd>No change is pending.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_NextOutputQueueLibrary</dt>
<dd>The name of the library that contains the next output queue. This field
is blank if no changes have been made to the writer.</dd>
<dt class="dlterm">CWBSO_PRT_NextOutputQueueName</dt>
<dd>The name of the next output queue to be processed. This field is blank
if no changes have been made to the writer.</dd>
<dt class="dlterm">CWBSO_PRT_NextSeparatorDrawer</dt>
<dd>This value indicates the drawer from which to take the separator pages
if there is a change to the writer. Possible values are: <dl><dt class="dlterm">*FILE</dt>
<dd>Separator pages print from the same drawer that the spooled file prints
from. If you specify a drawer different from the spooled file that contains
colored or different type paper, the page separator is more identifiable.</dd>
<dt class="dlterm">*DEVD</dt>
<dd>Separator pages print from the separator drawer that is specified in the
printer device description.</dd>
<dt class="dlterm">empty string</dt>
<dd>No pending change to the writer.</dd>
<dt class="dlterm">1</dt>
<dd>The first drawer.</dd>
<dt class="dlterm">2</dt>
<dd>The second drawer.</dd>
<dt class="dlterm">3</dt>
<dd>The third drawer.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_NextSeparators</dt>
<dd>The next number of separator pages to be printed when the change to the
writer takes place. Possible values are: <dl><dt class="dlterm">*FILE</dt>
<dd>The number of separator pages is specified by each file.</dd>
<dt class="dlterm">empty string</dt>
<dd>No pending change to the writer.</dd>
<dt class="dlterm">number of separators</dt>
<dd>The number of separator pages to be printed.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_NumberOfSeparators</dt>
<dd>The number of separator pages to be printed. Possible values are: <dl><dt class="dlterm">*FILE</dt>
<dd>The number of separator pages is specified by each file.</dd>
<dt class="dlterm">Number of separators</dt>
<dd>The number of separator pages to be printed.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_OnJobQueueStatus</dt>
<dd>Whether the writer is on a job queue and, therefore, is not currently
running. The possible values are Y (yes) or N (no).</dd>
<dt class="dlterm">CWBSO_PRT_OutputQueueLibrary</dt>
<dd>The name of the library that contains the output queue from which spooled
files are selected for printing.</dd>
<dt class="dlterm">CWBSO_PRT_OutputQueueName</dt>
<dd>The name of the output queue from which spooled files are being selected
for printing.</dd>
<dt class="dlterm">CWBSO_PRT_OutputQueueStatus</dt>
<dd>The status of the output queue from which spooled files are being selected
for printing. Possible values are: <dl><dt class="dlterm">H</dt>
<dd>The output queue is held.</dd>
<dt class="dlterm">R</dt>
<dd>The output queue is released.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_PrinterDeviceType</dt>
<dd>The type of the printer that is being used to print the spooled file.
Valid values are: <dl><dt class="dlterm">*SCS</dt>
<dd>SNA (Systems Network Architecture) character stream</dd>
<dt class="dlterm">*IPDS</dt>
<dd>Intelligent
Printer Data Stream™</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_SeparatorDrawer</dt>
<dd>Identifies the drawer from which the job and file separator pages are
to be taken. Possible values are: <dl><dt class="dlterm">*FILE</dt>
<dd>The separator page prints from the same drawer that the file is printed
from. If you specify a drawer different from the file that contains colored
or different type paper, the page separator is more identifiable.</dd>
<dt class="dlterm">*DEVD</dt>
<dd>The separator pages will print from the separator drawer that is specified
in the printer device description.</dd>
<dt class="dlterm">1</dt>
<dd>The first drawer.</dd>
<dt class="dlterm">2</dt>
<dd>The second drawer.</dd>
<dt class="dlterm">3</dt>
<dd>The third drawer.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_StartedByUser</dt>
<dd>The name of the user that started the writer.</dd>
<dt class="dlterm">CWBSO_PRT_Status</dt>
<dd>The overall status of the logical printer. This field is derived from
the printer device status (from the <span class="apiname">Retrieve Configuration Status
QDCRCFGS API</span>), the output queue status (from the List Printer and
Writer Status and the XPF macro) and writer status (from the <span class="apiname">Retrieve
Writer Information, QSPRWTRI</span>, API). Possible values are: <dl><dt class="dlterm">1</dt>
<dd>Unavailable</dd>
<dt class="dlterm">2</dt>
<dd>Powered off or not yet available</dd>
<dt class="dlterm">3</dt>
<dd>Stopped</dd>
<dt class="dlterm">4</dt>
<dd>Message waiting</dd>
<dt class="dlterm">5</dt>
<dd>Held</dd>
<dt class="dlterm">6</dt>
<dd>Stop (pending)</dd>
<dt class="dlterm">7</dt>
<dd>Hold (pending)</dd>
<dt class="dlterm">8</dt>
<dd>Waiting for printer</dd>
<dt class="dlterm">9</dt>
<dd>Waiting to start</dd>
<dt class="dlterm">10</dt>
<dd>Printing</dd>
<dt class="dlterm">11</dt>
<dd>Waiting for printer output</dd>
<dt class="dlterm">12</dt>
<dd>Connect pending</dd>
<dt class="dlterm">13</dt>
<dd>Powered off</dd>
<dt class="dlterm">14</dt>
<dd>Unusable</dd>
<dt class="dlterm">15</dt>
<dd>Being serviced</dd>
<dt class="dlterm">999</dt>
<dd>Unknown</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_TotalCopies</dt>
<dd>The total number of copies to be printed.</dd>
<dt class="dlterm">CWBSO_PRT_TotalPages</dt>
<dd>The total number of pages in the spooled file. Possible values are: <dl><dt class="dlterm">number</dt>
<dd>The number of pages in the spooled file.</dd>
<dt class="dlterm">0</dt>
<dd>No spooled file is printing.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_User</dt>
<dd>The name of the user who created the spooled file that the writer is currently
processing. This field is blank when no file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_UserSpecifiedData</dt>
<dd>The user-specified data that describe the file that the writer is currently
processing. This field is blank when no file is printing.</dd>
<dt class="dlterm">CWBSO_PRT_WaitingForDataStatus</dt>
<dd>Whether the writer has written all the data that is currently in the spooled
file and is waiting for more data. Possible values are: <dl><dt class="dlterm">N</dt>
<dd>The writer is not waiting for more data.</dd>
<dt class="dlterm">Y</dt>
<dd>The writer has written all the data currently in the spooled file and
is waiting for more data. This condition occurs when the writer is producing
an open spooled file with SCHEDULE(*IMMED) that is specified.</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_WaitingForDeviceStatus</dt>
<dd>Whether the writer is waiting to get the device from a job that is printing
directly to the printer. <dl><dt class="dlterm">N</dt>
<dd>The writer is not waiting for the device.</dd>
<dt class="dlterm">Y</dt>
<dd>The writer is waiting for the device</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_WriterJobName</dt>
<dd>The job name of the printer writer.</dd>
<dt class="dlterm">CWBSO_PRT_WriterJobNumber</dt>
<dd>The job number of the printer writer.</dd>
<dt class="dlterm">CWBSO_PRT_WriterJobUser</dt>
<dd>The name of the system user.</dd>
<dt class="dlterm">CWBSO_PRT_WriterStarted</dt>
<dd>Indication of whether a writer is started for this printer. Possible values
are: <dl><dt class="dlterm">0</dt>
<dd>No writer is started</dd>
<dt class="dlterm">1</dt>
<dd>Writer is started</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_WriterStatus</dt>
<dd>The status of the writer for this printer. Possible values are: <dl><dt class="dlterm">X'01'</dt>
<dd>Started</dd>
<dt class="dlterm">X'02'</dt>
<dd>Ended</dd>
<dt class="dlterm">X'03'</dt>
<dd>On job queue</dd>
<dt class="dlterm">X'04'</dt>
<dd>Held</dd>
<dt class="dlterm">X'05'</dt>
<dd>Waiting on message</dd>
</dl>
</dd>
<dt class="dlterm">CWBSO_PRT_WritingStatus</dt>
<dd>Whether the printer writer is in writing status. The possible values are:
<dl><dt class="dlterm">Y</dt>
<dd>The writer is in writing status.</dd>
<dt class="dlterm">N</dt>
<dd>The writer is not in writing status.</dd>
<dt class="dlterm">S</dt>
<dd>The writer is writing the file separators.</dd>
</dl>
</dd>
</dl>
</div>
<div class="section"><p>System Object Access accepts a comma-separated list of printer
names. Up to 100 printer names may be specified. A special value of “*ALL”
may be supplied to request a list of all printers on the iSeries server.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoaattrspecvalu.htm" title="The topics that are listed below provide a description of special values that may be returned by CWBSO_GetObjAttr, and specified on CWBSO_SetObjAttr, for each type of object. In addition, any special values that may be specified on CWBSO_SetListFilter for each type of list object are discussed.">SOA attribute special values</a></div>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink