131 lines
8.1 KiB
HTML
131 lines
8.1 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="PCML program tag" />
|
||
|
|
<meta name="abstract" content="The PCML program tag can be expanded with the following elements." />
|
||
|
|
<meta name="description" content="The PCML program tag can be expanded with the following elements." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="pcmlsyn.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="pcmlpgtg" />
|
||
|
|
<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>PCML program tag</title>
|
||
|
|
</head>
|
||
|
|
<body id="pcmlpgtg"><a name="pcmlpgtg"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">PCML program tag</h1>
|
||
|
|
<div><p>The PCML program tag can be expanded with the following elements.</p>
|
||
|
|
<div class="section"><p> </p>
|
||
|
|
<pre><strong><program name=</strong><em>"name"</em>
|
||
|
|
<strong>[ entrypoint=</strong><em>"entry-point-name"</em><strong> ]</strong>
|
||
|
|
<strong>[ epccsid=</strong>"ccsid" <strong>]</strong>
|
||
|
|
<strong>[ path=</strong><em>"path-name"</em><strong> ]</strong>
|
||
|
|
<strong>[ parseorder=</strong><em>"name-list"</em><strong> ]</strong>
|
||
|
|
<strong>[ returnvalue=</strong><em>"{ void | integer }"</em><strong> ]</strong>
|
||
|
|
<strong>[ threadsafe=</strong><em>"{ true | false }"</em><strong> ]></strong>
|
||
|
|
<strong></program></strong></pre>
|
||
|
|
<p>The following table lists the program tag
|
||
|
|
attributes. Each entry includes the attribute name, the possible valid values,
|
||
|
|
and a description of the attribute.</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="border" border="1" rules="all"><thead align="left"><tr class="tablemainheaderbar"><th valign="top" width="33.33333333333333%" id="d0e73"><strong>Attribute</strong></th>
|
||
|
|
<th valign="top" width="33.33333333333333%" id="d0e76"><strong>Value</strong></th>
|
||
|
|
<th valign="top" width="33.33333333333333%" id="d0e79"><strong>Description</strong></th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" width="33.33333333333333%" headers="d0e73 "><strong>entrypoint=</strong></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e76 "><em>entry-point-name</em></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e79 ">Specifies the name of the entry point within a service program object
|
||
|
|
that is the target of this program call.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="33.33333333333333%" headers="d0e73 "><strong>epccsid=</strong></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e76 "><em>ccsid</em></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e79 ">Specifies the CCSID of the entry point within a service program. For
|
||
|
|
more information, see the service program entry notes in the <a href="javadoc/com/ibm/as400/access/ServiceProgramCall.html">ServiceProgramCall
|
||
|
|
javadoc</a>. </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="33.33333333333333%" headers="d0e73 "><strong>name=</strong></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e76 "><em>name</em></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e79 ">Specifies the name of the program.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="33.33333333333333%" headers="d0e73 "><strong>path=</strong></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e76 "><em>path-name</em></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e79 ">Specifies the path to the program object. The default value is to assume
|
||
|
|
the program is in the QSYS library. <p>The path must be a valid integrated
|
||
|
|
file system path name to a *PGM or *SRVPGM object. If a *SRVPGM object is
|
||
|
|
called, the entrypoint attribute must be specified to indicate the name of
|
||
|
|
the entrypoint to be called.</p>
|
||
|
|
<p>If the entrypoint attribute is not specified,
|
||
|
|
the default value for this attribute is assumed to be a *PGM object from
|
||
|
|
the QSYS library. If the entrypoint attribute is specified, the default value
|
||
|
|
for this attribute is assumed to be a *SRVPGM object in the QSYS library.</p>
|
||
|
|
<p>The
|
||
|
|
path name must be specified as all uppercase characters.</p>
|
||
|
|
<p>Do not use
|
||
|
|
the <strong>path</strong> attribute when the application needs to set the path at run
|
||
|
|
time, for example, when a user specifies what library is used for the install.
|
||
|
|
In this case, use the <a href="javadoc/com/ibm/as400/data/ProgramCallDocument.html#SETPATH(JAVA.LANG.STRING, JAVA.LANG.STRING)">ProgramCallDocument.setPath() method</a>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="33.33333333333333%" headers="d0e73 "><strong>parseorder=</strong></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e76 "><em>name-list</em></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e79 ">Specifies the order in which output parameters will be processed.
|
||
|
|
The value specified is a blank separated list of parameter names in the order
|
||
|
|
in which the parameters are to be processed. The names in the list must be
|
||
|
|
identical to the names specified on the <strong>name</strong> attribute of tags belonging
|
||
|
|
to the <strong><program></strong>. The default value is to process output parameters
|
||
|
|
in the order the tags appear in the document. <p>Some programs return information
|
||
|
|
in one parameter that describes information in a previous parameter. For
|
||
|
|
example, assume a program returns an array of structures in the first parameter
|
||
|
|
and the number of entries in the array in the second parameter. In this case,
|
||
|
|
the second parameter must be processed in order for the ProgramCallDocument
|
||
|
|
to determine the number of structures to process in the first parameter.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="33.33333333333333%" headers="d0e73 "><strong>returnvalue=</strong></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e76 "><em>void</em> The program does not return a value. <p><em>integer</em> The
|
||
|
|
program returns a 4-byte signed integer.</p>
|
||
|
|
</td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e79 ">Specifies the type of value, if any, that is returned from a service
|
||
|
|
program call. This attribute is not allowed for *PGM object calls.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="33.33333333333333%" headers="d0e73 "><strong>threadsafe=</strong></td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e76 "><p><em>true</em> The program is considered to be thread-safe.</p>
|
||
|
|
<p><em>false</em> The
|
||
|
|
program is not thread-safe.</p>
|
||
|
|
</td>
|
||
|
|
<td valign="top" width="33.33333333333333%" headers="d0e79 "><p>When you call a Java™ program and an iSeries™ program that are on the same
|
||
|
|
server, use this property to specify whether you want to call the iSeries program
|
||
|
|
in the same job and on the same thread as the Java program. If you know your program
|
||
|
|
is thread-safe, setting the property to <em>true</em> results in better performance.</p>
|
||
|
|
<p>To
|
||
|
|
keep the environment safe, the default is to call programs in separate server
|
||
|
|
jobs. The default value is <em>false</em>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="pcmlsyn.htm" title="PCML consists of the following tags, each of which has its own attribute tags.">PCML syntax</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|