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.rzake_5.4.0.1/rzakemsticfevok.htm

181 lines
10 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="EVOKE (Evoke) keyword for ICF files" />
<meta name="abstract" content="Use this file- or record-level keyword to start a program on the remote system." />
<meta name="description" content="Use this file- or record-level keyword to start a program on the remote system." />
<meta name="DC.subject" content="EVOKE (Evoke) keyword" />
<meta name="keywords" content="EVOKE (Evoke) keyword" />
<meta name="DC.Relation" scheme="URI" content="rzakemstckeyw.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="icfevok" />
<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>ICF Files, EVOKE</title>
</head>
<body id="icfevok"><a name="icfevok"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">EVOKE (Evoke) keyword for ICF files</h1>
<div><p>Use this file- or record-level keyword to start a program on the
remote system.</p>
<div class="section"><div class="p">The format of the keyword is: <pre>EVOKE([library-/e1e/]program-name [parameter-1...[parameter-255]])</pre>
</div>
<div class="p">The
program-name can be any one of the following: <dl><dt class="dlterm">program-name</dt>
<dd>This is the name of the program to be started on the remote system. The
name is syntax-checked at creation time for a valid object name.</dd>
<dt class="dlterm">'character-string-1'</dt>
<dd>This is the name of the program to be started on the remote system. The
name you specify must be in a format acceptable to the remote system because
the character string will not be syntax-checked.</dd>
<dt class="dlterm">&amp;field-name-1</dt>
<dd>The specified field contains the name of the program to be started on
the remote system. The field name must be a valid field you have specified
in the record format and must be a character field (data type of A). The name
you specify must be in a format acceptable to the remote system.</dd>
</dl>
</div>
<div class="p">The optional library-name can be any one of the following:
<dl><dt class="dlterm">library-name/</dt>
<dd>This is the name of the library that contains the program to be started
on the remote system. The name is syntax-checked at creation time for a valid
object name. For this keyword, *CURLIB and *LIBL are not valid names. If either
one needs to be specified, a quoted character string should be used.</dd>
<dt class="dlterm">'character-string-2'/</dt>
<dd>This is the name of the library that contains the program to be started
on the remote system. The name you specify must be in a format acceptable
to the remote system because the character string will not be syntax-checked.</dd>
<dt class="dlterm">&amp;field-name-2/</dt>
<dd>The specified field contains the name of the library that contains the
program to be started on the remote system. The field name must be a valid
field you have specified in the record format and must be a character field
(data type of A). The name you specify must be in a format acceptable to the
remote system.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> If the remote system is an <span class="keyword">iSeries™</span> server
and no library was specified, the library list will be used to search for
the program.</div>
</div>
<p><var class="varname">Parameter-1</var> through <var class="varname">parameter-255</var> can
be any of the following:</p>
<dl><dt class="dlterm">'character-string-3'</dt>
<dd>This is a character string that is passed to the program on the remote
system. The character string must be in a format acceptable to the remote
system because it will not be syntax-checked.</dd>
<dt class="dlterm">[&amp;]field-name-3</dt>
<dd>This is the name of the field that contains the data you want passed to
the program on the remote system. The field name must be a valid field you
have specified in the record format.</dd>
<dt class="dlterm">numeric-value-3</dt>
<dd>This is a numeric value that is passed to the program on the remote system.
The numeric value can be a negative or positive value (signed or unsigned).
A decimal point of , or . is optional. No decimal alignment will be performed.
Leading zeros will not be suppressed. The data is sent as a zoned decimal
value. The following numeric values are all valid: <div class="p"> <p>999.6<br />
-999,6<br />
01587</p>
</div>
</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Special considerations when using the EVOKE keyword with ICF
files</h4><div class="p">These are special considerations when using the EVOKE keyword. <ul><li>When the EVOKE keyword is specified at the file level, you cannot specify
a field name as a parameter value.</li>
<li>The maximum length allowed for the combined program
name and library name is 64. The slash between the program name and the library
name is counted as part of the 64 bytes. Advanced Program-to-Program Communication
(APPC) does not send the slash unless it is specified within a literal (for
example, LIBRARY/PROGRAM).</li>
<li>The total length of parameter-1 through parameter-255 cannot be more than
32 767 bytes. <div class="note"><span class="notetitle">Note:</span> In calculating the maximum length of PIP data for
APPC, keep these considerations in mind: <p>Four bytes must be added to the
length of each of these parameters. An additional 4 bytes must be added if
any parameters are specified. These bytes are required by the system.</p>
<p>Use
the following formula to determine the total length of the parameters:</p>
<p>4 + (length of 1st parameter + 4) + (length of<br />
2nd parameter + 4)<br />
+ ... (length of nth parameter + 4)</p>
<p>Here is an example of how to
use this formula:</p>
<p>EVOKE(LIBRARY1/PROGRAM1 'THIS IS AN EXAMPLE OF<br />
A<br />
CHARACTER STRING' &amp;FIELD1 35)</p>
<p>Assume that &amp;FIELD1 has a length of 10.<br />
4 + (40 + 4) + (10 + 4) + (2 + 4) = 68</p>
</div>
</li>
<li>The length of each parameter (parameter-1 through parameter-255) should
be the same as the length of the corresponding parameter in the remote program.</li>
<li>If a field name with a usage of P is specified as a parameter of the EVOKE
keyword, this field is not sent as part of the data record.</li>
<li>A program evoked on an <span class="keyword">iSeries</span> server
will receive any parameters sent by the remote program just as if they had
been passed by the CL CALL command. <div class="note"><span class="notetitle">Note:</span> If the job on the <span class="keyword">iSeries</span> server
is a prestart job, the program must use the RTVDTAARA command to receive the
parameters.</div>
</li>
</ul>
</div>
<p>This keyword is required when either the SECURITY or SYNLVL keyword
is specified. At run time, the SECURITY and SYNLVL keywords are
used only when EVOKE is also in effect.</p>
<p>The EVOKE keyword is ignored
at run time when CANCEL, CNLINVITE, EOS, FAIL, NEGRSP, RSPCONFIRM, or RQSWRT
is in effect. These keywords must have option indicators when they apply
to a record for which the EVOKE keyword applies. If a CANCEL, CNLINVITE, EOS,
FAIL, NEGRSP, or RQSWRT keyword with no option indicator applies to a record
for which EVOKE applies, an error message is issued and the EVOKE keyword
is ignored at creation time.</p>
<p>You cannot specify EVOKE with the TIMER
keyword.</p>
<p>Option indicators are valid for this keyword and are required
if this keyword is specified more than once for each record format or file.</p>
</div>
<div class="example"><h4 class="sectiontitle">Example</h4> <p>The following example shows how to specify
the EVOKE keyword.</p>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
00010A R RCD
00020A 01 : EVOKE(LIBRARY1/PROGRAM1) <strong>(1)</strong>
00030A 02 : EVOKE(LIBRARY2/PROGRAM2) <strong>(1)</strong>
A : :
A : :
00090A R RCD2 EVOKE(&amp;FIELD2/&amp;FIELD1 'ABC' 10.1 +
00100A FIELD3) <strong>(2)</strong>
00110A FIELD1 10A P
00120A FIELD2 10A P
00130A FIELD3 5B P
A</pre>
<div class="note"><span class="notetitle">Note:</span> <dl><dt class="dlterm">(1)</dt>
<dd>If indicator 01 is on, PROGRAM1 in LIBRARY1 will be started. If indicator
02 is on, PROGRAM2 in LIBRARY2 will be started.</dd>
<dt class="dlterm">(2)</dt>
<dd>&amp;FIELD1 contains the name of the program to be started. &amp;FIELD2
contains the name of the library. The character string ABC, numeric value
10.1, and the value in FIELD3 will be passed to the program on the remote
system.</dd>
</dl>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakemstckeyw.htm" title="These topics contain the keyword entries that you can specify when you define ICF files.">DDS keyword entries for ICF files (positions 45 through 80)</a></div>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink