ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzakd_5.4.0.1/rzakdmstptoverl.htm

214 lines
12 KiB
HTML
Raw Normal View History

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="OVERLAY (Overlay) keyword in printer files" />
<meta name="abstract" content="Use this record-level keyword to print an overlay." />
<meta name="description" content="Use this record-level keyword to print an overlay." />
<meta name="DC.subject" content="OVERLAY (Overlay) keyword" />
<meta name="keywords" content="OVERLAY (Overlay) keyword" />
<meta name="DC.Relation" scheme="URI" content="rzakdmstprkey.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakdmstpositn.htm" />
<meta name="DC.Relation" scheme="URI" content="../rzalu/rzalupagrtt.htm" />
<meta name="DC.Relation" scheme="URI" content="../rzau6/rzau6overlays.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakdmstptoverl" />
<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>OVERLAY (Overlay) keyword in printer files</title>
</head>
<body id="rzakdmstptoverl"><a name="rzakdmstptoverl"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">OVERLAY (Overlay) keyword in printer files</h1>
<div><p>Use this record-level keyword to print an overlay.</p>
<div class="section"><p>The format of the keyword is:</p>
<pre>OVERLAY([(library-name | &amp;library-name-field)/overlay-name] |
&amp;overlay-name-field]
position-down | &amp;position-down-field
position-across | &amp;position-across-field
[(*ROTATION rotation-field) | &amp;rotation-field-name)]) </pre>
<p>The
overlay-name, position-down, and position-across parameters are required.</p>
<p>Use
the optional library-name parameter to further qualify the overlay. If you
do not specify the library-name parameter, *LIBL is used to search for the
overlay at print time.</p>
<div class="note"><span class="notetitle">Note:</span> If an application uses private
resources (for example, fonts, page segments, overlays, or GDF files not distributed
with the system), be aware of the following information. When referencing
these resources, if you specify *LIBL or you do not specify a library name,
the resources must be available through the library list used by the application
creating the spooled file.</div>
<div class="p">You can specify the library-name,
overlay-name, position-down, position-across, and rotation parameters as constants,
program-to-system fields, or a combination of both, as shown in the following
examples: <ul><li>[library-name/]overlay-name...</li>
<li>[library-name/]&amp;field1...</li>
<li>[&amp;field2/]overlay-name...</li>
<li>[&amp;field3/]&amp;field4...</li>
</ul>
</div>
<p>When you specify the library-name as a program-to-system field,
the field must exist in the same record format as the OVERLAY keyword. It
must be defined as length of 10, data type A (character), and usage P (program-to-system).</p>
<p>When
you specify the overlay-name as a program-to-system field, the field must
exist in the same record format as the OVERLAY keyword. It must be defined
as length of 8, data type A (character), and usage P (program-to-system).</p>
<p>When
you specify the position-down or position-across as program-to-system fields,
the fields must be defined as length 5 with 3 decimal positions, data type
S, and usage P. A program-to-system field for rotation must be defined as
length 3 with 0 decimal positions, data type S and usage P.</p>
<p>The position-down
parameter defines the vertical starting point of the overlay relative to the
margins specified on the FRONTMGN or BACKMGN parameter on the CRTPRTF command.
Valid values are 0 to 57.790 cm (0 to 22.750 in.).</p>
<p>The position-across
parameter defines the horizontal starting point of the overlay relative to
the margins specified on the FRONTMGN or BACKMGN parameter on the CRTPRTF
command. Valid values are 0 to 57.790 cm (0 to 22.750 in.).</p>
<div class="note"><span class="notetitle">Note:</span> The UOM
parameter on the CRTPRTF command determines the units of measure for the position-down
and position-across parameter values. If the value specified for a parameter
is outside the valid range, it is flagged when the spooled file is created.</div>
<p>An
error message is issued at print time if the overlay does not fit on the page.</p>
<p>The
optional rotation parameter allows you to specify a rotation value for the
overlay. Valid values are 0, 90, 180 and 270. It is specified as an expression
of the form (*ROTATION rotation). Consider the following additional points
about the rotation parameter:</p>
<ul><li>If the rotation parameter is omitted, then overlays are not automatically
rotated when using the PAGRTT parameter on the printer file. See the <a href="../books/s5445319.pdf" target="_blank">iSeries™ guide
to output </a><img src="wbpdf.gif" alt="Link to PDF" /> book for information about overlays.</li>
<li>The following IBM<sup>®</sup> printers support the rotation parameter: <ul><li>Infoprint<sup>®</sup> 60</li>
<li>Infoprint 2000</li>
<li>Infoprint 3000</li>
<li>Infoprint 4000</li>
<li>Infoprint Hi-Lite
Color Printer, model 4005-HCI</li>
</ul>
These printers must be at ucode level 9.2 or later.</li>
</ul>
<p>Specify DEVTYPE(*AFPDS) on the CRTPRTF command when OVERLAY is specified
in the file. If DEVTYPE is changed to anything other than *AFPDS, the keyword
is ignored and a warning message is issued at print time.</p>
<p>When the OVERLAY
keyword is specified on a record format, all fields within the record format
must be positioned using the POSITION keyword.</p>
<p>An error message is issued
if a constant field is specified in a record format where the OVERLAY keyword
is also specified.</p>
<p>You can specify this keyword multiple times on a
record.</p>
<p>A maximum of 10 overlays can be used on a single page.</p>
<p>Overlays
are not automatically rotated when using the PAGRTT keyword or the PAGRTT
parameter on the printer file.</p>
<p>You cannot specify OVERLAY with the following
keywords:</p>
<ul><li>SPACEA</li>
<li>SPACEB</li>
<li>SKIPA</li>
<li>SKIPB</li>
</ul>
<p>Option indicators are valid for this keyword.</p>
</div>
<div class="section"><h4 class="sectiontitle">Example 1</h4><p>The following example shows how to specify
the OVERLAY keyword.</p>
<div class="note"><span class="notetitle">Note:</span> By using the code examples, you agree to the
terms of the <a href="codedisclaimer.htm">Code license and disclaimer information</a>.</div>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
A*
A R REC1 OVERLAY(MYLIB/OVL04 1.234 14.62)
A*
A R REC2 OVERLAY(&amp;LIB/&amp;OVLS &amp;POSD &amp;POSA);
A LIB 10A P
A OVLS 8A P
A POSD 5S 3P
A POSA 5S 3P
A*
A R REC3 OVERLAY(MYOVL 11.219 0.2)
A OVERLAY(YOUROVL 7.3 9.27)
A*
A R REC4
A 01 OVERLAY(MYLOGO 0.0 3.01)
A*
A R REC5 OVERLAY(&amp;LIB2/&amp;OVL2 &amp;POSD2 &amp;POSA2 +
A (*ROTATION 90))
A LIB2 10A P
A OVL2 8A P
A POSD2 5S 3P
A POSA2 5S 3P
A*
A</pre>
<div class="note"><span class="notetitle">Note:</span> The UOM parameter on the CRTPRTF command determines the
units of measure for the parameter values.</div>
<p>REC1 prints overlay OVL04
found in library MYLIB. The overlay prints 1.234 units down and 14.62 units
across from the margins specified on the FRONTMGN or BACKMGN parameter on
the CRTPRTF command.</p>
<p>REC2 allows the application program to specify
the library by setting program variables LIB and overlay name by setting program
variables OVLS. The application specifies the overlay position at run time
by setting POSD and POSA.</p>
<p>REC3 prints two overlays. MYOVL prints 11.219
units down and 0.2 units across from the margins specified on the FRONTMGN
or BACKMGN parameter on the CRTPRTF command. YOUROVL prints 7.3 units down
and 9.27 units across from the margins specified on the CRTPRTF command. Both
overlays are located using *LIBL.</p>
<p>REC4 prints MYLOGO only if indicator
01 is on.</p>
<p>REC5 allows the application program to specify the library
by setting field LIB2 and specify overlay name by setting field OVL2. The
overlay position is specified by the application at run time by setting POSD2
and POSA2. The overlay rotation is set to a value of 90 degrees.</p>
</div>
<div class="section"><h4 class="sectiontitle">Example 2</h4><p>The second coding example uses DDS and
P-fields.</p>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
*
R REC1 OVERLAY(&amp;MYLIB/&amp;MYOVL +
&amp;OFFD &amp;OFFA
*
MYLIB 10A P
MYOVL 8A P
OFFD 5S 3P
OFFA 5S 3P</pre>
<p>The following example illustrates
the location of the overlay using the previous DDS code. The application program
specifies the library by setting field MYLIB and specifies overlay name by
setting field MYOVL. The application program also sets a value of 2 in field
OFFD and a value of 2 in field OFFA. Both the FRONTMGN and BACKMGN parameters
on the CRTPRTF command are set to 2.</p>
<br /><img src="rzakd502.gif" alt="An illustration of the results produced by Example 2. The overlay is&#xA;positioned 4 units down and 4 units across, 2 units down and across from a&#xA;margin of 2 units down and across." /><br /></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakdmstprkey.htm" title="See the valid keyword entries for defining printer files in this topic.">Keyword entries for printer files (positions 45 through 80)</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="rzakdmstpositn.htm" title="Use this field-level keyword to define the location of a named field on the page.">POSITION (Position) keyword in printer files</a></div>
</div>
<div class="relinfo"><strong>Related information</strong><br />
<div><a href="../rzalu/rzalupagrtt.htm">Page rotation (PAGRTT) parameter</a></div>
<div><a href="../rzau6/rzau6overlays.htm">Overlays</a></div>
</div>
</div>
</body>
</html>