140 lines
12 KiB
HTML
140 lines
12 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="concept" />
|
|
<meta name="DC.Title" content="Scenario: Integrated Language Environment (ILE) APIs" />
|
|
<meta name="abstract" content="The example APIs in this section represent two general functions of APIs--change and retrieve." />
|
|
<meta name="description" content="The example APIs in this section represent two general functions of APIs--change and retrieve." />
|
|
<meta name="DC.Relation" scheme="URI" content="apiUse.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRegisterILEC.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRegisterCOBOL.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRegisterILECOBOL.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRegisterRPG.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRegisterILERPG.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRemoveILEC.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRemoveCOBOL.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRemoveILECOBOL.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRemoveRPG.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRemoveILERPG.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRetrieveILEC.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRetrieveCOBOL.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRetrieveILECOBOL.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRetrieveRPG.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileRetrieveILERPG.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileOverview.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="cmnCommon.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/ileGeneric.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/ileKeyed.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/ileError.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/ileReceiver.htm" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="ileScenario" />
|
|
<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>Scenario: Integrated Language Environment (ILE)
|
|
APIs</title>
|
|
</head>
|
|
<body id="ileScenario"><a name="ileScenario"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">Scenario: Integrated Language Environment<sup>®</sup> (ILE)
|
|
APIs</h1>
|
|
<div><p>The example APIs in this section represent two general functions
|
|
of APIs--change and retrieve.</p>
|
|
<p>For a detailed description of how to use the API, use information in API
|
|
information format.</p>
|
|
<p>The following examples illustrate the use of ILE APIs. The examples use
|
|
the registration facility APIs. The registration facility APIs provide a means
|
|
for storing and retrieving information about exit points and exit programs.
|
|
An <em>exit point</em> is a specific point in a system function or program where
|
|
control may be passed to one or more exit programs. An <em>exit program</em> is
|
|
a program to which control is passed from an exit point. The examples show
|
|
how to manipulate exit points and exit programs, how to retrieve information
|
|
about exit points and exit programs that are stored with the registration
|
|
facility, and how to call an exit program.</p>
|
|
<p>Several of the registration facility APIs manipulate the information that
|
|
the registration facility repository contains. One API is provided for retrieving
|
|
information from the repository.</p>
|
|
<div class="note"><span class="notetitle">Note:</span> These descriptions and the programs that support them are in RPG. You
|
|
can, however, view the same programs in different languages.</div>
|
|
<p>IBM grants you a nonexclusive copyright license to use all programming
|
|
code examples from which you can generate similar function tailored to your
|
|
own specific needs.</p>
|
|
<p><img src="./delta.gif" alt="Start of change" />SUBJECT TO ANY STATUTORY WARRANTIES WHICH CANNOT BE EXCLUDED,
|
|
IBM, ITS PROGRAM DEVELOPERS AND SUPPLIERS MAKE NO WARRANTIES OR CONDITIONS
|
|
EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT,
|
|
REGARDING THE PROGRAM OR TECHNICAL SUPPORT, IF ANY. <img src="./deltaend.gif" alt="End of change" /></p>
|
|
<p><img src="./delta.gif" alt="Start of change" />UNDER NO CIRCUMSTANCES IS IBM, ITS PROGRAM DEVELOPERS OR SUPPLIERS
|
|
LIABLE FOR ANY OF THE FOLLOWING, EVEN IF INFORMED OF THEIR POSSIBILITY: <img src="./deltaend.gif" alt="End of change" /></p>
|
|
<img src="./delta.gif" alt="Start of change" /><ol><li>LOSS OF, OR DAMAGE TO, DATA;</li>
|
|
<li>SPECIAL, INCIDENTAL, OR INDIRECT DAMAGES, OR FOR ANY ECONOMIC CONSEQUENTIAL
|
|
DAMAGES; OR </li>
|
|
<li>LOST PROFITS, BUSINESS, REVENUE, GOODWILL, OR ANTICIPATED SAVINGS.</li>
|
|
</ol><img src="./deltaend.gif" alt="End of change" />
|
|
<p><img src="./delta.gif" alt="Start of change" />SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION
|
|
OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO SOME OR ALL OF THE ABOVE LIMITATIONS
|
|
OR EXCLUSIONS MAY NOT APPLY TO YOU.<img src="./deltaend.gif" alt="End of change" /></p>
|
|
</div>
|
|
<div>
|
|
<ul class="ullinks">
|
|
<li class="ulchildlink"><strong><a href="ileRegisterILEC.htm">Example in ILE C: Register exit point and add exit program</a></strong><br />
|
|
This program registers an exit point with the registration facility. After the successful completion of the registration of the exit point, an exit program is added to the exit point.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRegisterCOBOL.htm">Example in OPM COBOL: Register exit point and add exit program</a></strong><br />
|
|
This program registers an exit point with the registration facility. After the successful completion of the registration of the exit point, an exit program is added to the exit point.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRegisterILECOBOL.htm">Example in ILE COBOL: Register exit point and add exit program</a></strong><br />
|
|
This program registers an exit point with the registration facility. After the successful completion of the registration of the exit point, an exit program is added to the exit point.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRegisterRPG.htm">Example in OPM RPG: Register exit point and add exit program</a></strong><br />
|
|
This program registers an exit point with the registration facility. After the successful completion of the registration of the exit point, an exit program is added to the exit point.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRegisterILERPG.htm">Example in ILE RPG: Register exit point and add exit program</a></strong><br />
|
|
This program registers an exit point with the registration facility. After the successful completion of the registration of the exit point, an exit program is added to the exit point.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRemoveILEC.htm">Example in ILE C: Remove exit program and deregister exit point</a></strong><br />
|
|
This program removes an exit program and deregisters an exit point from the registration facility.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRemoveCOBOL.htm">Example in OPM COBOL: Remove exit program and deregister exit point</a></strong><br />
|
|
This program removes an exit program and deregisters an exit point from the registration facility.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRemoveILECOBOL.htm">Example in ILE COBOL: Remove exit program and deregister exit point</a></strong><br />
|
|
This program removes an exit program and deregisters an exit point from the registration facility.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRemoveRPG.htm">Example in OPM RPG: Remove exit program and deregister exit point</a></strong><br />
|
|
This program removes an exit program and deregisters an exit point from the registration facility.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRemoveILERPG.htm">Example in ILE RPG: Remove exit program and deregister exit point</a></strong><br />
|
|
This program removes an exit program and deregisters an exit point from the registration facility.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRetrieveILEC.htm">Example in ILE C: Retrieve exit point and exit program information</a></strong><br />
|
|
This program retrieves exit point and exit program information. After retrieving the exit point information, the program resolves to each associated exit program and calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRetrieveCOBOL.htm">Example in OPM COBOL: Retrieve exit point and exit program information</a></strong><br />
|
|
This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRetrieveILECOBOL.htm">Example in ILE COBOL: Retrieve exit point and exit program information</a></strong><br />
|
|
This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRetrieveRPG.htm">Example in OPM RPG: Retrieve exit point and exit program information</a></strong><br />
|
|
This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.</li>
|
|
<li class="ulchildlink"><strong><a href="ileRetrieveILERPG.htm">Example in ILE RPG: Retrieve exit point and exit program information</a></strong><br />
|
|
This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each, exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.</li>
|
|
</ul>
|
|
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="apiUse.htm" title="Provides scenarios for and practical application of using APIs.">Using APIs</a></div>
|
|
</div>
|
|
<div class="relconcepts"><strong>Related concepts</strong><br />
|
|
<div><a href="ileOverview.htm" title="The Integrated Language Environment (ILE) model is a set of tools and associated system support designed to enhance program development on a system.">APIs for the Integrated Language Environment</a></div>
|
|
<div><a href="cmnCommon.htm" title="API names contain verbs that are similar to the i5/OS licensed program: change, create, remove, and retrieve.">API information format</a></div>
|
|
</div>
|
|
<div class="relref"><strong>Related reference</strong><br />
|
|
<div><a href="../apis/ileGeneric.htm">Generic header files using ILE APIs</a></div>
|
|
<div><a href="../apis/ileKeyed.htm">Example: Keyed interface using ILE APIs</a></div>
|
|
<div><a href="../apis/ileError.htm">Error handling using ILE APIs</a></div>
|
|
<div><a href="../apis/ileReceiver.htm">Examples: Receiver variables using ILE APIs</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |