friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzakd_5.4.0.1/rzakdmstafprsc.htm

586 lines
37 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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="concept" />
<meta name="DC.Title" content="AFPRSC (AFP Resource) keyword in printer files" />
<meta name="abstract" content="Use this record-level keyword to specify an AFP or non-AFP resource stored in the integrated file system." />
<meta name="description" content="Use this record-level keyword to specify an AFP or non-AFP resource stored in the integrated file system." />
<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="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="rzakdmstafprsc" />
<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>AFPRSC (AFP Resource)
keyword in printer files</title>
</head>
<body id="rzakdmstafprsc"><a name="rzakdmstafprsc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">AFPRSC (AFP Resource)
keyword in printer files</h1>
<div><p>Use this record-level keyword to specify an AFP™ or non-AFP resource stored in the integrated
file system.</p>
<p>A specific set of resource types is supported (see <a href="#rzakdmstafprsc__objtypes">Table 1</a>).</p>
<p>AFPRSC might not be used to specify fonts, overlays,
page segments, form definitions, or page definitions.</p>
<p>The format of the keyword is:</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>AFPRSC ('resource-name' | &amp;resource-name-field
object-type | object-comp-id | &amp;object-type-field
position-down | &amp;position-down-field
position-across | &amp;position-across-field
[(*SIZE width | &amp;width-field height | &amp;height-field)]
[(*ROTATION rotation | &amp;rotation-field-name)]
[(*PATH 'path-to-use' | *NONE | *CWD | &amp;path-to-use-field-name)]
[(*MAPOPT mapping-option | &amp;mapping-option-field-name)]
[(*COLORPRF color-profile | color-profile-comp-id | &amp;color-profile-field-name)]
[(*SECRSC 'external-name' | &amp;external-name-field
secondary-resource-type | sec-resource-comp-id | &amp;sec-resource-type-field-name
'internal-name' | internal-name-hex-id | &amp;internal-name-field
'secondary-resource-path' | *NONE | *CWD | &amp;secondary-resource-path-field)])</pre>
<div class="note"><span class="notetitle">Note:</span> When you provide the resource-name, path-to-use, external-name, or secondary-resource-path
as a literal value, the operating system assumes that it is specified in the
coded character set identifier (CCSID) of the DDS source physical file. When
you provide the resource-name, path-to-use, external-name, or secondary-resource-path
as a program-to-system field, the operating system assumes that it is specified
in the default job CCSID.</div>
<p>The resource-name is the name of the file in the integrated
file system, including the file extension, if there is one. If the complete
name is not specified, the resource will not be found. The maximum size of
the quoted string is 250 bytes. The name cannot contain characters that can
be interpreted as path name delimiters. To ensure portability across all AFP platforms,
see the <em>MO:DCA™ Reference
(SC31-6802)</em> book for a list of characters that are allowed in an external
resource name.</p>
<p>The object-type describes the format of the data in the named file. Currently
supported values are listed in the following table under the <em>Object type
name</em> column. An object-comp-id value can be provided instead of the object-type.
The corresponding object-comp-id values are listed in the following table
under the <em>Component ID</em> column. The maximum size value allowed for an
object-comp-id is 99999. The following table lists the currently supported
object-types and the numeric value that identifies the type of the object:</p>
<div class="tablenoborder"><a name="rzakdmstafprsc__objtypes"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="rzakdmstafprsc__objtypes" frame="border" border="1" rules="all"><caption>Table 1. Object types supported on AFPRSC keyword</caption><thead align="left"><tr><th valign="top" width="23.986486486486484%" id="d0e70">Object type name</th>
<th valign="top" width="23.986486486486484%" id="d0e72">Component ID</th>
<th valign="top" width="52.02702702702703%" id="d0e74">Description</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*JFIF</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">23</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">Commonly referred to as <em>JPG</em></td>
</tr>
<tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*PDFSPO</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">25</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">A PDF single-page object</td>
</tr>
<tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*PDFSPOTR</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">49</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">A PDF single-page object with transparency</td>
</tr>
<tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*PCLPO</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">34</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">A PCL page object</td>
</tr>
<tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*BCOCA</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">– (see note)</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">An AFPDS BCOCA™ (bar code) object</td>
</tr>
<tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*GOCA</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">– (see note)</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">An AFPDS GOCA (graphics) object</td>
</tr>
<tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*IOCA</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">– (see note)</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">An AFPDS IOCA (image) object</td>
</tr>
<tr><td valign="top" width="23.986486486486484%" headers="d0e70 ">*TIFF</td>
<td valign="top" width="23.986486486486484%" headers="d0e72 ">14</td>
<td valign="top" width="52.02702702702703%" headers="d0e74 ">Tag Image File Format</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The component ID for this object type is not used by <span class="keyword"><font color="Purple">i5/OS™</font></span>.</div>
<p>If you specify an object component ID value that is not
supported by the device, the result will be unpredictable and will depend
on the device to which the file is sent.</p>
<p>The position-down parameter defines the vertical starting point of the
resource 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 resource 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 resource does not fit on
the page.</p>
<p>Use the optional width and height parameters to specify the size of the
resource. They are specified as an expression of the form (*SIZE width height).
If these parameters are omitted, then the size of the resource will not be
changed (the resource will print with the size it was originally created with).</p>
<p>The optional width parameter defines the width of the resource. 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 resource. 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>
<div class="note"><span class="notetitle">Note:</span> The UOM parameter on the CRTPRTF command determines the units of measure
for the width and height 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>The optional rotation parameter allows you to specify a rotation value
for the resource. 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 AFP or non-AFP
resources are not automatically rotated when using the PAGRTT parameter on
the printer file.</li>
<li>Verify that your printer supports this function.</li>
</ul>
<p>Use the optional path-to-use parameter to further qualify the AFP resource. It
is specified as an expression of the form (*PATH path-to-use). If you do not
specify the path-to-use parameter, environment variable QIBM_AFP_RESOURCES_PATH
and the explicit path <samp class="codeph">/QIBM/UserData/OS400/AFPresources</samp> are
used to search for the file. The possible values for path-to-use are:</p>
<ul><li>*NONE. A path is not specified. *NONE has the same effect as if the path-to-use
parameter is not supplied at all.</li>
<li>*CWD. The current working directory for the job is specified.</li>
<li>path-to-use. An absolute path name is specified. This must
be a single directory. The value is a quoted string whose maximum length when
the path name is provided in the DDS is 2000.</li>
</ul>
<div class="note"><span class="notetitle">Note:</span> When referencing a resource, if you specify (*PATH *NONE) or if you
do not specify *PATH at all, the resource must be available through directories
specified with environment variable QIBM_AFP_RESOURCES_PATH or the explicit
path <samp class="codeph">/QIBM/UserData/OS400/AFPresources</samp>.</div>
<p>See <a href="#rzakdmstafprsc__searchpath">How the operating system searches
for resources on the <samp class="codeph">path-to-use</samp> or the <samp class="codeph">secondary-resource-path</samp> parameters</a> for
information about how <span class="keyword"><font color="Purple">i5/OS</font></span> searches
for resources.</p>
<p>Use the optional mapping-option parameter to specify how the object should
be mapped in the object placement area. It is specified as an expression of
the form (*MAPOPT mapping-option).</p>
<p>The following table shows the available mapping options.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th align="center" valign="top" width="22.2972972972973%" id="d0e218">Mapping option</th>
<th align="center" valign="top" width="21.283783783783782%" id="d0e220">DDS value</th>
<th align="center" valign="top" width="56.41891891891891%" id="d0e222">Description</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="22.2972972972973%" headers="d0e218 ">Position</td>
<td valign="top" width="21.283783783783782%" headers="d0e220 ">*P</td>
<td valign="top" width="56.41891891891891%" headers="d0e222 ">It specifies that the object is positioned at the
upper, left corner of the object placement area, as defined by the position-across
and position-down parameters. Any portion of the object that falls outside
the object placement area, as defined by the object's size, is not trimmed.
If this occurs, the printer will report an error irrespective of the printer
file's value for the FIDELITY parameter.</td>
</tr>
<tr><td valign="top" width="22.2972972972973%" headers="d0e218 ">Position and trim</td>
<td valign="top" width="21.283783783783782%" headers="d0e220 ">*PT</td>
<td valign="top" width="56.41891891891891%" headers="d0e222 ">It specifies that the object is positioned at the
upper left corner of the object placement area, as defined by the position-across
and position-down parameters. Any portion of the object that falls outside
the object placement area, as defined by the object's size, is trimmed.</td>
</tr>
<tr><td valign="top" width="22.2972972972973%" headers="d0e218 ">Scale to fit</td>
<td valign="top" width="21.283783783783782%" headers="d0e220 ">*ST</td>
<td valign="top" width="56.41891891891891%" headers="d0e222 ">It specifies that the object is scaled to fit within
the object placement area. The object is centered in the object placement
area and it is scaled up or down to fit this area. Scaling is symmetrical.
This option ensures that all of the data in the object is presented at the
largest possible size and the object is not trimmed.</td>
</tr>
<tr><td valign="top" width="22.2972972972973%" headers="d0e218 ">Center and trim</td>
<td valign="top" width="21.283783783783782%" headers="d0e220 ">*CT</td>
<td valign="top" width="56.41891891891891%" headers="d0e222 ">It specifies that the object is centered in the
object placement area. Any portion of the object that falls outside the object
placement area is trimmed.</td>
</tr>
<tr><td valign="top" width="22.2972972972973%" headers="d0e218 ">Scale to fill</td>
<td valign="top" width="21.283783783783782%" headers="d0e220 ">*SL</td>
<td valign="top" width="56.41891891891891%" headers="d0e222 ">It specifies that the object is centered in the
object placement area. The object is then scaled, so that it completely fills
the object placement area. This might require that the object be asymmetrically
scaled.</td>
</tr>
</tbody>
</table>
</div>
<p>Not all options are available for all types of objects. The following table
shows which options are available. If you do not specify a mapping option,
the default mapping option for the object type is used.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th align="center" valign="top" id="d0e268">Object type</th>
<th align="center" valign="top" id="d0e270">Available mapping options</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e268 ">*BCOCA</td>
<td valign="top" headers="d0e270 ">*P (default)</td>
</tr>
<tr><td valign="top" headers="d0e268 ">*GOCA</td>
<td valign="top" headers="d0e270 ">*PT (default), *ST, *CT, *SL</td>
</tr>
<tr><td valign="top" headers="d0e268 ">*IOCA</td>
<td valign="top" headers="d0e270 ">*PT (default), *ST, *CT, *SL</td>
</tr>
<tr><td valign="top" headers="d0e268 ">All others</td>
<td valign="top" headers="d0e270 ">*PT (default), *P, *ST, *CT, *SL</td>
</tr>
</tbody>
</table>
</div>
<p>Use the optional color-profile parameter to specify a color profile, if
it is required by the object. It is specified as an expression of the form
(*COLORPRF color-profile). The color profile is resident within a printer.
A PostScript level 1 file might contain color that is specific to a geography-based
offset press standard, which defines the color rendering.</p>
<div class="note"><span class="notetitle">Note:</span> The color-profile parameter requires device support, and should be used
only when you are certain that the intended device supports the color profile
that you want to specify. Specifying a color profile that is not supported
by a device can produce unpredictable results.</div>
<p>The following table lists the color profiles that are supported in AFP environments,
and the numeric value that identifies the color profile. The currently supported
values for color-profile are defined in the <em>Color profile name</em> column;
the equivalent values for color-profile-comp-id are listed in the <em>Component
ID</em> column. The maximum size value for a color-profile-comp-id is 99999.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th align="center" valign="top" width="25.76271186440678%" id="d0e315">Color profile name</th>
<th align="center" valign="top" width="22.033898305084744%" id="d0e317">Component ID</th>
<th align="center" valign="top" width="52.20338983050847%" id="d0e319">Description</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="25.76271186440678%" headers="d0e315 ">*CMYKSWOP</td>
<td valign="top" width="22.033898305084744%" headers="d0e317 ">0</td>
<td valign="top" width="52.20338983050847%" headers="d0e319 ">CMYKSWOP (US)</td>
</tr>
<tr><td valign="top" width="25.76271186440678%" headers="d0e315 ">*CMYKEURO</td>
<td valign="top" width="22.033898305084744%" headers="d0e317 ">1</td>
<td valign="top" width="52.20338983050847%" headers="d0e319 ">CMYK Euroscale (Europe)</td>
</tr>
</tbody>
</table>
</div>
<p>If you specify an unsupported color-profile-comp-id value,
the result will depend on the printer to which the file is sent. Some printers
do not support a color profile with certain object types. If you specify any
of these unsupported combinations, the result will depend on the printer to
which the file is sent.</p>
<p>Use the optional secondary resource parameter to specify up to 5 secondary
resources for the named resource. It is specified as an expression of the
form (*SECRSC external-name secondary-resource-type internal-name secondary-resource-path).
A secondary resource is a resource that resides in the integrated file system
and is referenced within the file identified by the resource-name (also called
the primary resource).</p>
<div class="note"><span class="notetitle">Note:</span> Use of this optional parameter requires device support. Use this parameter
when the resource identified in the resource-name parameter requires one or
more secondary resources. Support for secondary resources is device dependent.
This option should be used only when it is known that the resource identified
in the resource-name field requires a secondary resource and that the necessary
device support exists. Otherwise, unpredictable results will occur.</div>
<p>The external-name is the name of the file, including the file extension,
if there is one. If the complete name is not specified, the secondary resource
will not be found. The value is a quoted string whose maximum size is 250
bytes. The name cannot contain characters which can be interpreted as path
name delimiters.</p>
<p>The secondary-resource-type identifies the type of the secondary resource.
The following table lists the corresponding secondary-resource-types and the
numeric value that identifies the type of the secondary resource. Currently
supported values for the secondary-resource-type are listed in the <em>Resource
type name</em> column; the equivalent values for sec-resource-comp-id are listed
under the <em>Component ID</em> column. The maximum size value for a sec-resource-comp-id
is 99999.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th align="center" valign="top" width="25.76271186440678%" id="d0e359">Resource type name</th>
<th align="center" valign="top" width="22.033898305084744%" id="d0e361">Component ID</th>
<th align="center" valign="top" width="52.20338983050847%" id="d0e363">Description</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="25.76271186440678%" headers="d0e359 ">*PDFRO</td>
<td valign="top" width="22.033898305084744%" headers="d0e361 ">26</td>
<td valign="top" width="52.20338983050847%" headers="d0e363 ">PDF resource object</td>
</tr>
<tr><td valign="top" width="25.76271186440678%" headers="d0e359 ">*IOCAFS45RO</td>
<td valign="top" width="22.033898305084744%" headers="d0e361 ">47</td>
<td valign="top" width="52.20338983050847%" headers="d0e363 ">IOCA FS45 resource object</td>
</tr>
</tbody>
</table>
</div>
<p>If you specify an unsupported sec-resource-comp-id value, the result will
depend on the device to which the file is sent. Some devices do not support
secondary resources with certain object types. Also, some devices do not support
any secondary resource and object type combination. If you specify any of
these unsupported combinations, the result will depend on the device to which
the file is sent.</p>
<p>The internal-name is the name of the secondary resource as it is referenced
in the primary resource. The value is a quoted string or a HEX string (internal-name-hex-id).
This value might be different than the external-name. You must obtain the
internal-name from the person or application that generated the primary resource.
The maximum length of a quoted string is 250 bytes. The format of the internal-name-hex-id
is X'hhhh' where 'h' are hexadecimal characters. The maximum number of HEX
characters is 500. Therefore, the maximum length of a HEX string is 503 bytes.</p>
<div class="p">You can specify a path indicating where the resource is stored with the
secondary-resource-path. The possible values are listed as follows: <ul><li>*NONE. A path is not specified.</li>
<li>*CWD. The current working directory for the job is specified.</li>
<li>Secondary-resource-path. An absolute path name is specified. This must
be a single directory. The value is a quoted string whose maximum length when
the path name is provided in the DDS is 2000.</li>
</ul>
</div>
<div class="note"><span class="notetitle">Note:</span> When referring to these resources, if you specify *NONE for the secondary
resource path, the resource must be available through directories specified
with environment variable QIBM_AFP_RESOURCES_PATH or the explicit path /QIBM/UserData/OS400/AFPresources.</div>
<p>See <a href="#rzakdmstafprsc__searchpath">How the operating system searches
for resources on the <samp class="codeph">path-to-use</samp> or the <samp class="codeph">secondary-resource-path</samp> parameters</a> for
information about how <span class="keyword"><font color="Purple">i5/OS</font></span> searches
for resources.</p>
<p>You can specify the resource-name, object-type, position-down, position-across,
width, height, rotation, path-to-use, mapping-option, color-profile, external-name,
secondary-resource-type, internal-name, and secondary-resource-path parameters
as constants, program-to-system fields, or a combination of both. For example,
the required parameters can be expressed in the following ways:</p>
<pre>AFPRSC('Some resource name' *JFIF 10.2 11.2 ... )
AFPRSC(&amp;field1 *JFIF 10.2 11.2 ... )
AFPRSC(&amp;field1 &amp;field2 10.2 11.2 ... )
AFPRSC(&amp;field1 &amp;field2 &amp;field3 12.3 ... )
AFPRSC(&amp;field1 *JFIF 10.3 &amp;field3 ... )
AFPRSC(&amp;field1 &amp;field2 &amp;field3 &amp;field4 ... )</pre>
<p>When you specify the resource-name as a program-to-system field, the field
must exist in the same record format as the AFPRSC keyword. It must be defined
with a length in the range 1 to 250, data type A (character), and usage P
(program-to-system).</p>
<p>When you specify the object-type as a program-to-system field, the field
must exist in the same record format as the AFPRSC keyword. It must be defined
with a length of 10, data type A (character), and usage P (program-to-system).
If you provide a numeric component id for the value of the field, assign a
zoned decimal value, left-aligned in the field, and padded with blanks or
HEX zeros. The maximum size of the numeric component id value is 99999.</p>
<p>When you specify position-down or position-across as program-to-system
fields, the fields must exist in the same record format as the AFPRSC keyword.
The fields must be defined as length 5 with 3 decimal positions, data type
S, and usage P.</p>
<p>When you specify the width or height fields as program-to-system fields,
the fields must exist in the same record format as the AFPRSC keyword. The
fields must be defined as length 5 with 3 decimal positions, data type S,
and usage P.</p>
<p>A program-to-system field for rotation must exist in the same record format
as the AFPRSC keyword, and it must be defined as length 3 with 0 decimal positions,
data type S, and usage P.</p>
<p>When you specify path-to-use as a program-to-system field, the field must
exist in the same record format as the AFPRSC keyword. It must be defined
with a length in the range 1 to 5000, data type A (character), and usage P.</p>
<p>When you specify mapping-option as a program-to-system field, the field
must exist in the same record format as the AFPRSC keyword. It must be defined
as length 3, data type A (character), and usage P.</p>
<p>When you specify color-profile as a program-to-system field,
the field must exist in the same record format as the AFPRSC keyword. It must
be defined as length 9, data type A (character), and usage P. If you provide
a numeric component id for the value of the field, assign a zoned decimal
value, left- aligned in the field, and padded with blanks or HEX zeros. The
maximum size of the numeric component id value is 99999. </p>
<p>When you specify external-name as a program-to-system field, the field
must exist in the same record format as the AFPRSC keyword. It must be defined
with a length in the range of 1 to 250, data type A (character), and usage
P.</p>
<p>When you specify secondary-resource-type as a program-to-system
field, the field must exist in the same record format as the AFPRSC keyword.
It must be defined as length 11, data type A (character), and usage P. If
you provide a numeric component id for the value of the field, assign a zoned
decimal value, left-aligned in the field and padded with blanks or HEX zeros.
The maximum size of the numeric component id value is 99999.</p>
<p>When you specify internal-name as a program-to-system field, the field
must exist in the same record format as the AFPRSC keyword. It must be defined
with a length in the range of 3 to 252, data type A (character), and usage
P. The first two bytes of the field's value must be a two byte binary length
field. The value in the length field indicates the length of the name in the
remainder of the program-to-system field.</p>
<p>When you specify secondary-resource-path as a program-to-system field,
the field must exist in the same record format as the AFPRSC keyword. It must
be defined with a length in the range of 1 to 5000, data type A (character),
and usage P.</p>
<p>Specify DEVTYPE(*AFPDS) on the CRTPRTF command when AFPRSC 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 AFPRSC 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 AFPRSC keyword is also specified.</p>
<p>Each resource-name can only be used to refer to a single AFP or non-AFP
resource per page. Each external-name can be used only to refer to a single
secondary resource per page. Multiple instances of the same resource are allowed
on a page. Identical names that are specified with different paths are treated
as different resources and will result in an error.</p>
<p>A maximum of 10 AFP or non-AFP resources can be used on a single page.
Only one AFPRSC keyword can be used on a record.</p>
<p>AFP or non-AFP resources are not automatically rotated
when using the PAGRTT keyword or the PAGRTT parameter on the printer file.</p>
<div class="p">You cannot specify AFPRSC with the following keywords: <ul><li>SPACEA</li>
<li>SPACEB</li>
<li>SKIPA</li>
<li>SKIPB</li>
</ul>
</div>
<div class="note"><span class="notetitle">Note:</span> Feature Print
Services Facility™ (PSF) is required for use of this keyword. If PSF is
not installed, you will not be able to print files using this keyword and
specifying DEVTYPE(*AFPDS).</div>
<p>Option indicators are valid for this keyword.</p>
<p id="rzakdmstafprsc__searchpath"><a name="rzakdmstafprsc__searchpath"><!-- --></a><strong>How the operating system searches for resources on the <samp class="codeph">path-to-use</samp> or
the <samp class="codeph">secondary-resource-path</samp> parameters:</strong></p>
<p>The operating system searches for resources for the <samp class="codeph">path-to-use</samp> parameter
or the <samp class="codeph">secondary-resource-path</samp> parameter in the following
way:</p>
<ul><li>If you do not specify the path-to-use parameter for the primary resource
path, or you specify (PATH *NONE), or if you specify *NONE for the secondary
resource path: <ol><li>The path specified with the system-level value for environment variable
QIBM_AFP_RESOURCES_PATH is searched.</li>
<li>If the resource is not found, and the spooled file resides on an independent
disk pool, the /<em>&lt;independent-disk-pool-name&gt;</em>/QIBM/UserData/OS400/AFPresources
directory, if it exists, is searched. You are responsible for creating directory
/QIBM/UserData/OS400/AFPresources on an independent disk pool. Subdirectories
are not searched.</li>
<li>If the resource is not found or the spooled file resides on *SYSBAS, the
/QIBM/UserData/OS400/AFPresources directory on the system ASP is searched.
Subdirectories are not searched.</li>
</ol>
</li>
<li>If you specify (*PATH *CWD) for the primary resource path or *CWD for
the secondary resource path: <ol><li>The current working directory for the job that generated the spooled file
is searched.</li>
<li>If the resource is not found, the path specified with the system-level
value for environment variable QIBM_AFP_RESOURCES_PATH is searched.</li>
<li>If the resource is not found and the spooled file resides on an independent
disk pool, the /<em>&lt;independent-disk-pool-name&gt;</em>/QIBM/UserData/OS400/AFPresources
directory, if it exists, is searched. You are responsible for creating directory
/QIBM/UserData/OS400/AFPresources on an independent disk pool. Subdirectories
are not searched.</li>
<li>If the resource is not found or the spooled file resides on *SYSBAS, the
/QIBM/UserData/OS400/AFPresources directory on the system ASP is searched.
Subdirectories are not searched.</li>
</ol>
</li>
<li>If you specify a path name, the specified path, which must be absolute
and a single directory, is searched. If the resource is not found, an error
is reported. No further searching is performed.</li>
</ul>
<p>When specifying a specific path name, and sending the spooled file to another iSeries™ server,
that path must exist on the receiving server. If the path does not exist on
the receiving server, PSF reports an error when searching for the resource.</p>
<p>When specifying *CWD or a specific path, and sending the spooled file to
a non-iSeries system, the path information will be ignored by the receiving
system.</p>
<div class="section"><h4 class="sectiontitle">Example 1</h4><p>The following example shows how to specify
the AFPRSC keyword.</p>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
A*
A R REC1 AFPRSC('My_resource' *PDFSPO 1.234 +
A 14.62)
A*
A R REC2 AFPRSC(&amp;RESN &amp;RESTYP &amp;POSD &amp;POSA)
A RESN 125A P
A RESTYP 10A P
A POSD 5S 3P
A POSA 5S 3P
A*
A R REC3 AFPRSC('Some_resource' *IOCA +
A 4.332 5.661 (*SIZE 10.12 12.345) +
A (*ROTATION 90) (*PATH *CWD))
A R REC4 AFPRSC(&amp;RESN &amp;RESTYP &amp;POSD &amp;POSA +
A (*SIZE &amp;WDTH &amp;HGT) +
A (*ROTATION &amp;ROT) (*PATH &amp;PATH))
A RESN 125A P
A RESTYP 10A P
A POSD 5S 3P
A POSA 5S 3P
A WDTH 5S 3P
A HGT 5S 3P
A ROT 3S 0P
A PATH 500A P
A R REC5
A 10 AFPRSC('Optional_resource' +
A *PDFSPO +
A 1.2 4.6 (*MAPOPT *P)(*COLORPRF +
A *CMYKSWOP) +
A (*SECRSC 'My resource' 26 +
A 'Internal name' '/My/path')
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 for the size and positioning parameters.</div>
<p>REC1 prints resource
'My_resource' found in either the environment variable QIBM_AFP_RESOURCES_PATH
or the explicit path /QIBM/UserData/OS400/AFPresources. The resource is a
PDFSPO resource. The resource 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 resource
name, resource type, the position down and the position across parameters
by setting program variables at run time. The resource name is provided in
variable RESN. The object type of the resource is provided in RESTYP. The
resource is positioned by the values in POSD (position down) and POSA (position
across).</p>
<p>REC3 uses optional keyword parameters. The resource named 'Some_resource'
prints 4.332 units down and 5.661 units across from the margins specified
on the FRONTMGN or BACKMGN parameter on the CRTPRTF command. The resource
is an IOCA object. It prints with a size of 10.12 units by 12.345 units. It
is rotated 90 degrees and found in the user's current working directory.</p>
<p>REC4
uses program-to-system fields for all of the parameters for the keyword. Therefore,
the values for the parameters are supplied at run time.</p>
<p>REC5 prints
the resource named 'Optional resource' only if indicator 10 is on. REC5 also
illustrates the use of additional optional parameters. The position mapping
option is requested. A color profile of CMYKSWOP is requested. A secondary
resource object 'My resource' whose secondary resource type is PDF resource
object is provided; its internal name is 'Internal name' and it is found in
path '/My/path'.</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 AFPRSC(&amp;RESN &amp;OBJT &amp;OFFD &amp;OFFA)
*
RESN 10A P
OBJT 10A P
OFFD 5S 3P
OFFA 5S 3P</pre>
<p>The following example illustrates
the location of the resource using the previous DDS code. The application
program specifies the resource name and object type by setting fields RESN
and OBJT. 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="rzakd505.gif" alt="An illustration of the results produced by Example 2. The resource 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>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink