ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzakc_5.4.0.1/rzakcmstdfsfpmq.htm

178 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="SFLPGMQ (Subfile Program Message Queue) keyword for display files" />
<meta name="abstract" content="Use this field-level keyword on the second (and last) field in the subfile record format for a message subfile." />
<meta name="description" content="Use this field-level keyword on the second (and last) field in the subfile record format for a message subfile." />
<meta name="DC.subject" content="SFLPGMQ (Subfile Program Message Queue) keyword, Subfile Program Message Queue (SFLPGMQ) keyword" />
<meta name="keywords" content="SFLPGMQ (Subfile Program Message Queue) keyword, Subfile Program Message Queue (SFLPGMQ) keyword" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstkeyent.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfsfctl.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfsflnz.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfsfmky.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="rzakcmstdfsfpmq" />
<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>SFLPGMQ (Subfile Program Message Queue) keyword for display files</title>
</head>
<body id="rzakcmstdfsfpmq"><a name="rzakcmstdfsfpmq"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">SFLPGMQ (Subfile Program Message Queue) keyword for display files</h1>
<div><p>Use this field-level keyword on the second (and last) field in
the subfile record format for a message subfile.</p>
<div class="section"><p>This field contains the name of the program message queue used
by the <span class="keyword">i5/OS™</span> operating
system to build a message subfile. In addition, SFLPGMQ can be specified on
the subfile control record format when the SFLINZ keyword is specified on
the subfile control record format.</p>
<div class="p">The format of the keyword is: <pre>SFLPGMQ([10] | [276])</pre>
</div>
<p>When
10 is specified, SFLPGMQ generates a 10-byte field. 10 is the default.</p>
<p>When
276 is specified, SFLPGMQ generates a 276-byte field.</p>
<div class="p">This field is
predefined as a character data type, hidden field. The following rules apply:
<ul><li>The field name and the SFLPGMQ keyword and parameters are the only DDS
you can specify for this field.</li>
<li>If the name of the program message queue placed in this field at processing
time is less than the field length (10 or 276 bytes), it must be left-aligned
and padded with blanks.</li>
</ul>
</div>
<div class="p">For Integrated
Language Environment<sup>®</sup> (ILE) programs using the 276-byte parameter value,
the format of the field data must be as follows: <ul><li>The first 256 bytes contains the ILE call message queue name. The call
message queue name is the same as the ILE procedure name. The name must be
left-aligned and padded with blanks.</li>
<li>Bytes 257 through 266 will optionally contain the ILE module name. The
name, when specified, must be left-aligned and padded with blanks. If no module
name is provided, these bytes must be set to blanks.</li>
<li>Bytes 267 through 276 will optionally contain the name of the ILE bound
program name. The name, when specified, must be left-aligned and padded with
blanks. If no bound program name is provided, these bytes must be set to blanks. <div class="note"><span class="notetitle">Notes:</span> <ol><li>If a parameter value of 10 is used on SFLPGMQ and an ILE procedure name
longer than 10 bytes is placed into this field at processing time, the procedure
name is truncated to 10 bytes. The results will be unpredictable.</li>
<li>If a parameter value of 276 is used on SFLPGMQ and a program message queue
name is placed into this field at processing time, bytes 257 through 276 must
be set to blanks. If these bytes are not blank, the system assumes that a
call message queue name has been given and will not find the specified program
message queue.</li>
</ol>
</div>
</li>
<li>If the SFLPGMQ keyword is specified on both the subfile and subfile control
record, the SFLPGMQ parameter values must match. However, different subfiles
within the same file can use different SFLPGMQ parameter values.</li>
</ul>
</div>
<p>This field is required on the subfile record format (identified
by the SFL keyword) to build the subfile one message at a time through multiple
output operations to the subfile record format.</p>
<p>You can also specify
this field on the subfile control record format (identified by the SFLCTL
keyword) to build the subfile all at once through a single output operation
to the subfile control record. Specify option indicators with the SFLINZ keyword
to control the way the subfile is built.</p>
</div>
<div class="section"><h4 class="sectiontitle">Multiple output operation</h4><p>If you specify the field
name and SFLPGMQ on the subfile record, you build the subfile one message
at a time with separate output operations to the subfile record format. For
each output operation, the message reference key must be in the first field
of the record (SFLMSGKEY keyword), and the name of the program message queue
must be in the second field. At the time of the output operation, the <span class="keyword">i5/OS</span> program retrieves the identified
message from the queue and places it in the subfile as a record.</p>
<div class="note"><span class="notetitle">Note:</span> A
CL program cannot be used for a multiple output operation. The relative record
number required each time a message is built is not supported for CL.</div>
</div>
<div class="section"><h4 class="sectiontitle">Single output operation</h4><p>If you specify SFLPGMQ (with
its named field) and the SFLINZ keyword on the subfile control record format,
you build the entire subfile with one output operation directed to the subfile
control record format. On the output operation, the <span class="keyword">i5/OS</span> operating
system initializes the subfile with all messages that are on the program message
queue whose name is in the SFLPGMQ field. If necessary, the <span class="keyword">i5/OS</span> operating
system extends the subfile to contain all messages on the queue. For this
function, the SFLMSGRCD, SFLMSGKEY, and SFLPGMQ keywords must be specified
with the subfile record format (SFL keyword). The SFLPGMQ and SFLMSGKEY keywords
are ignored for this function and your program need not set the values of
their fields.</p>
</div>
<div class="section"><h4 class="sectiontitle">Special value</h4><p>The SFLPGMQ field can contain a special
value, * (asterisk), instead of a program message queue name. If the program
moves an asterisk to the SFLPGMQ field, the <span class="keyword">i5/OS</span> operating
system uses the message queue of the program issuing the output operation.
You cannot use an asterisk if your program is a CL program.</p>
</div>
<div class="section"><h4 class="sectiontitle">Both multiple and single output operations</h4><p>If you
specify SFLPGMQ with both the subfile record format and subfile control record
format, you can use the single operation function one time and the multiple
operation function some other time. Do this by setting indicators before issuing
the output operation; however, all operations to a particular subfile must
be consistent (multiple or single, but not intermixed) when preparing for
a single display of the subfile.</p>
<p>Option indicators and display size
condition names are not valid for this keyword.</p>
</div>
<div class="example"><h4 class="sectiontitle">Example</h4><p>The following example shows how to specify
the SFLPGMQ keyword.</p>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
00010A R RCDMSGILE SFL SFLMSGRCD(3)
00020A FLDKEY SFLMSGKEY
00030A FLDPGM SFLPGMQ(276)
00040A R SFLCTLILE SFLCTL(RCDMSG)
00050A 01 SFLINZ
00060A SFLPAG(17)
00070A SFLSIZ(17)
00080A SFLDSP SFLDSPCTL
A :
A :
00110A FLDPGM SFLPGMQ(276)
A R RCDMSGOPM SFL SFLMSGRCD(3)
A FLDKEY SFLMSGKEY
A FLDPGM SFLPGMQ
A R SFLCTLOPM SFLCTL(RCDMSG)
A 02 SFLINZ
A SFLPAG(17)
A SFLSIZ(17)
A SFLDSP SFLDSPCTL
A :
A :
A FLDPGM SFLPGMQ(10)
A</pre>
<p>In this example, the program can build the subfile with
more than one output operation (indicator 01 off) or a single output operation
(indicator 01 on) to the subfile control record format.</p>
<p>In the first
record, the name of the subfile program queue can be as long as 276 bytes,
while the name of the subfile program queue in the third record format can
only be 10 bytes long.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakcmstkeyent.htm" title="You type the keyword entries that define display files in positions 45 through 80 (functions).">DDS keyword entries for display files (positions 45 through 80)</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="rzakcmstdfsfctl.htm" title="Use this record-level keyword to specify that this record format is to be a subfile control record format. This record format must immediately follow the subfile record format.">SFLCTL (Subfile Control) keyword for display files</a></div>
<div><a href="rzakcmstdfsflnz.htm" title="Use this record-level keyword on the subfile control record format to specify that the i5/OS operating system is to initialize all records in the subfile on an output operation to the subfile control record format (identified by the SFLCTL keyword).">SFLINZ (Subfile Initialize) keyword for display files</a></div>
<div><a href="rzakcmstdfsfmky.htm" title="Use this field-level keyword on the first field in the subfile record format for a message subfile (Subfile (SFL) and Subfile Message Record (SFLMSGRCD) keywords specified).">SFLMSGKEY (Subfile Message Key) keyword for display files</a></div>
</div>
</div>
</body>
</html>