ibm-information-center/dist/eclipse/plugins/i5OS.ic.apiref_5.4.0.1/ileOverview.htm

103 lines
6.3 KiB
HTML
Raw Permalink Normal View History

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="concept" />
<meta name="DC.Title" content="APIs for the Integrated Language Environment" />
<meta name="abstract" content="The Integrated Language Environment (ILE) model is a set of tools and associated system support designed to enhance program development on a system." />
<meta name="description" content="The Integrated Language Environment (ILE) model is a set of tools and associated system support designed to enhance program development on a system." />
<meta name="DC.Relation" scheme="URI" content="conEnvironment.htm" />
<meta name="DC.Relation" scheme="URI" content="cmnCommon.htm" />
<meta name="DC.Relation" scheme="URI" content="ileScenario.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="ileOverview" />
<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>APIs for the Integrated Language Environment</title>
</head>
<body id="ileOverview"><a name="ileOverview"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">APIs for the Integrated Language Environment</h1>
<div><p>The Integrated
Language Environment<sup>®</sup> (ILE) model is a set of tools and associated system
support designed to enhance program development on a system.</p>
<p>Bindable ILE APIs are independent from the high-level languages. This can
be useful when mixed languages are involved.</p>
<p>The ILE APIs provide functions such as:</p>
<ul><li>Dynamic screen management (DSM)</li>
<li>National language support</li>
<li>Mail server framework</li>
<li>Problem management</li>
<li>Programming and control language (CL)</li>
<li>Registration facility</li>
<li>Source debugger</li>
</ul>
<p>ILE APIs use the following naming conventions:</p>
<ul><li>Start with the letter Q.</li>
<li>Are followed by a 2- or 3-character internal component identifier.</li>
<li>Can be up to 30 characters.</li>
<li>Are case sensitive.</li>
</ul>
<p>ILE service programs (*SRVPGM) use the following naming conventions:</p>
<ul><li>Start with the letter Q.</li>
<li>Are followed by a 2- or 3-character internal component identifier.</li>
<li>Are limited to 8 characters.</li>
<li>Are uppercase.</li>
</ul>
<p>Integrated
Language Environment (ILE) APIs are contained within service programs
that the calling program binds to. In addition, some ILE APIs provide a program
interface for the original program model (OPM) languages. You can usually
distinguish between the *SRVPGM interface and the *PGM interface by the name
of the API. For example, the registration facility APIs provide both a program
and a service program entry point (procedure) interface. For the Register
Exit Point API, the service program entry point interface is named QusRegisterExitPoint
and the program interface is named QUSRGPT. A bindable procedure name can
be up to 30 characters and mixed uppercase and lowercase. A program interface
name can be up to 8 characters and is all uppercase.</p>
<p>A binding directory is used for ILE APIs that are contained in service
programs. A <em>binding directory</em> is a list of names of modules and service
programs that provides a reference by name and type. Service programs that
contain ILE APIs are in the QUSAPIBD binding directory. This binding directory
is implicitly used by ILE compilers to resolve the ILE API references; therefore,
it is not necessary to explicitly name the service program or the API binding
directory when creating programs that use ILE APIs. If you provide your own
APIs with the same name, make sure that you also provide your own binding
directory or service program.</p>
<p>Most APIs (ILE and non-ILE) have a header file supplied by <span class="keyword">i5/OS™</span>.
These header files reside in the optionally installable library QSYSINC. The
header files provide the prototypes for the API as well as define any structures
that are used by the API. The QSYSINC library is used by the ILE C compiler
to search for header files; therefore, it is not necessary to specify a library
qualifier for any header files that reside in the QSYSINC library. When coding
in ILE C, remember to enclose the header file name in less-than (&lt;) and
greater-than (&gt;) symbols because this affects how the library list is processed
in locating the header file.</p>
<p>It is typical for an API that is not retrieving information not to return
any output to the caller other than the error code parameter. If an error
did not occur when using APIs, the requested function completed successfully.</p>
<p>The presentation of the ILE APIs is similar to that of the OPM APIs.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="conEnvironment.htm" title="This topic introduces the operating environments that i5/OS APIs exist on a system.">API environments</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<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><a href="ileScenario.htm" title="The example APIs in this section represent two general functions of APIs--change and retrieve.">Scenario: Integrated Language Environment (ILE) APIs</a></div>
</div>
</div>
</body>
</html>