77 lines
5.8 KiB
HTML
77 lines
5.8 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="API information format" />
|
|
<meta name="abstract" content="API names contain verbs that are similar to the i5/OS licensed program: change, create, remove, and retrieve." />
|
|
<meta name="description" content="API names contain verbs that are similar to the i5/OS licensed program: change, create, remove, and retrieve." />
|
|
<meta name="DC.Relation" scheme="URI" content="concept.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="cmnDesc.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="cmnFormat.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="cmnField.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="cmnError.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="cmnExtract.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="cmnProcessList.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="opmOverview.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="ileOverview.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="conVerbs.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="conReceiver.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="opmScenario.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="cmnCommon" />
|
|
<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>API information format</title>
|
|
</head>
|
|
<body id="cmnCommon"><a name="cmnCommon"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">API information format</h1>
|
|
<div><p>API names contain verbs that are similar to the <span class="keyword">i5/OS™</span> licensed
|
|
program: change, create, remove, and retrieve.</p>
|
|
</div>
|
|
<div>
|
|
<ul class="ullinks">
|
|
<li class="ulchildlink"><strong><a href="cmnDesc.htm">API description</a></strong><br />
|
|
For most APIs, the API description information has similar section headings.</li>
|
|
<li class="ulchildlink"><strong><a href="cmnFormat.htm">API format</a></strong><br />
|
|
The format section in API information describes a format name.</li>
|
|
<li class="ulchildlink"><strong><a href="cmnField.htm">API field descriptions</a></strong><br />
|
|
The field descriptions section describes the fields found in the format section.</li>
|
|
<li class="ulchildlink"><strong><a href="cmnError.htm">API error messages</a></strong><br />
|
|
The error messages section lists error messages that can occur when you use the API.</li>
|
|
<li class="ulchildlink"><strong><a href="cmnExtract.htm">Extracting a field from the format</a></strong><br />
|
|
The format section describes where the field that you want is located within the receiver variable.</li>
|
|
<li class="ulchildlink"><strong><a href="cmnProcessList.htm">Processing lists that contain data structures</a></strong><br />
|
|
Some API information contains a list where each entry in the list is itself a data structure.</li>
|
|
</ul>
|
|
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="concept.htm" title="Describes the underlying concepts that you need to understand to work effectively with APIs. Among the concepts covered are basic concepts, programming considerations, and terminology.">API concepts</a></div>
|
|
</div>
|
|
<div class="relconcepts"><strong>Related concepts</strong><br />
|
|
<div><a href="opmOverview.htm" title="This topic describes the naming conventions of Original Program Model (OPM) APIs, the initial APIs on the system.">APIs for the Original Program Model environment</a></div>
|
|
<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="conReceiver.htm" title="A receiver variable is a program variable that is used as an output field to contain information that is returned from an API.">Receiver variables</a></div>
|
|
<div><a href="opmScenario.htm" title="This scenario demonstrates the use of an original program model (OPM) API in several different programs.">Scenario: Original Program Model (OPM) API</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 class="relref"><strong>Related reference</strong><br />
|
|
<div><a href="conVerbs.htm" title="The two to three letters following the APIs make up an internal component identifier. The last part of the API name identifies the action or function of the API. The information after the component ID is an abbreviation of the verb that describes the function of the API.">OPM and ILE API verbs and abbreviations</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |