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

207 lines
11 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="PAGSEG (Page Segment) keyword in printer files" />
<meta name="abstract" content="Use this record-level keyword to print a page segment." />
<meta name="description" content="Use this record-level keyword to print a page segment." />
<meta name="DC.subject" content="PAGSEG (Page Segment) keyword, Page Segment (PAGSEG) keyword" />
<meta name="keywords" content="PAGSEG (Page Segment) keyword, Page Segment (PAGSEG) 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/rzau6pageseg.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="rzakdmstptpagse" />
<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>PAGSEG (Page Segment) keyword in printer files</title>
</head>
<body id="rzakdmstptpagse"><a name="rzakdmstptpagse"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">PAGSEG (Page Segment) keyword in printer files</h1>
<div><p>Use this record-level keyword to print a page segment.</p>
<div class="section"><p>The format of the keyword is:</p>
<pre>PAGSEG(library-name | &amp;library-name-field/ page-segment-name |
&amp;page-segment-name-field
position-down | &amp;position-down-field
position-across | &amp;position-across-field
[(*SIZE width | &amp;width-field height | height-field)]
[(*ROTATION rotation | &amp;rotation)] </pre>
<p>The
page-segment-name, position-down, and position-across parameters are required.</p>
<p>Use
the optional library-name parameter to further qualify the page segment. If
you do not specify the library name, *LIBL is used to search for the page
segment 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. 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>
<p>You can specify the library-name, page-segment-name,
position-down, position-across, width, height and rotation parameters as
constants, program-to-system fields, or a combination of both, as shown in
the following examples:</p>
<ul><li>[library-name/]page-segment-name...</li>
<li>[library-name/]&amp;field1...</li>
<li>[&amp;field2/]page-segment-name...</li>
<li>[&amp;field3/]&amp;field4...</li>
</ul>
<p>When you specify the library-name as a program-to-system field, the
field must exist in the same record format as the PAGSEG 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 page-segment-name as a program-to-system field, the field
must exist in the same record format as the PAGSEG 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, position-across, width, or height parameters
as program-to-system fields, the fields must be defined as length 5 with 3
decimal positions, data type S, and usage P. Rotation must be defined as length
with 3 and 0 decimal points, data type S and usage P.</p>
<p>The position-down
parameter defines the vertical starting point of the page segment 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 page segment 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 page segment does not fit on
the page.</p>
<p>Use the optional width and height parameters to specify the
size of the page segment. They are specified as an expression of the form
(*SIZE width height). If these parameters are omitted, then the size of the
page segment will not be changed (the page segment will print with the size
it was originally created with).</p>
<p>The optional width parameter defines
the width of the page segment. Valid values are 0.001 to 57.790 cm (0.001
to 22.750 in.). If the width is specified, then the height parameter must
also be specified.</p>
<p>The optional height parameter defines the height
of the page segment. Valid values are 0.001 to 57.790 cm (0.001 to 22.750
in.). If the height is specified, then the width parameter must also be specified.</p>
<p>The
optional rotation parameter allows you to specify a rotation value for the
page segment. It is specified as an expression of the form (*ROTATION rotation).
Valid values are 0, 90, 180 and 270.</p>
<div class="note"><span class="notetitle">Note:</span> If the rotation parameter is
omitted, then page segments are not automatically rotated when using the PAGRTT
parameter on the printer file. Feature Print Services Facility™ (PSF)
is required for use of this keyword.</div>
<p>Specify DEVTYPE(*AFPDS) on the
CRTPRTF command when PAGSEG 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 PAGSEG 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 PAGSEG keyword is also specified.</p>
<p>You can
specify the PAGSEG keyword multiple times on a record.</p>
<p>A maximum of
10 page segments can be used per page.</p>
<p>Page segments are not automatically
rotated when using the PAGRTT keyword or 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 page segments .</p>
<p>You cannot specify
PAGSEG at the same level as 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 PAGSEG keyword.</p>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
A*
A R REC1 PAGSEG(MYLIB/PAGSEG5 3.527 4.162)
A*
A R REC2 PAGSEG(&amp;LIB/&amp;PSEG &amp;POSD &amp;POSA);
A LIB 10A P
A PSEG 8A P
A POSD 5S 3P
A POSA 5S 3P
A*
A R REC3 PAGSEG(MYSEG 0.0 3.759)
A PAGSEG(YOURSEG 0.0 5.233)
A*
A R REC4
A 01 PAGSEG(MYSEG 0.0 3.01)
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 page segment
PAGSEG5 found in library MYLIB. The page segment prints 3.527 units down and
4.162 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 field LIB and specify page segment name by setting
field PSEG. The application specifies the page segment position at run time
by setting POSD and POSA.</p>
<p>REC3 prints two page segments. MYSEG prints
0 units down and 3.759 units across from the margins specified on the FRONTMGN
or BACKMGN parameter on the CRTPRTF command. YOURSEG prints 0 units down and
5.233 units across from the margins specified on the CRTPRTF command. Both
page segments are located using *LIBL.</p>
<p>REC4 prints MYSEG only if indicator
01 is on.</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 PAGSEG(&amp;MYLIB/&amp;PAGSEG +
&amp;OFFD &amp;OFFA
*
MYLIB 10A P
PAGSEG 8A P
OFFD 5S 3P
OFFA 5S 3P</pre>
<p>The following graphic
illustrates the location of the page segment using the previous DDS code.
The application program specifies the library by setting field MYLIB and specifies
the page segment name by setting field PAGSEG. 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="rzakd501.gif" alt="An illustration of the results produced by Example&#xA;2. The page segment is positioned 4 units down and 4 units across, 2 units&#xA;down and across from a 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/rzau6pageseg.htm">Page segments</a></div>
</div>
</div>
</body>
</html>