80 lines
5.6 KiB
HTML
80 lines
5.6 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 parameters" />
|
||
|
|
<meta name="abstract" content="After you have found the API that you want to use, you need to code a call to an API and pass to the API the required set of parameters appropriate for that API." />
|
||
|
|
<meta name="description" content="After you have found the API that you want to use, you need to code a call to an API and pass to the API the required set of parameters appropriate for that API." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="concept.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="conPassParm.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="conIOParm.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="conOffset.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="conOvD.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="error.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="opmIlecompare.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="conParameter" />
|
||
|
|
<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 parameters</title>
|
||
|
|
</head>
|
||
|
|
<body id="conParameter"><a name="conParameter"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">API parameters</h1>
|
||
|
|
<div><p>After you have found the API that you want to use, you need to
|
||
|
|
code a call to an API and pass to the API the required set of parameters appropriate
|
||
|
|
for that API.</p>
|
||
|
|
<p>Parameters can be:</p>
|
||
|
|
<ul><li><em>Required</em>: All of the parameters in the specified order </li>
|
||
|
|
<li><em>Optional</em>: All or none of the parameters within the optional group.
|
||
|
|
You must either include or exclude the entire group; you cannot use just one
|
||
|
|
of these parameters by itself. In addition, you must include all preceding
|
||
|
|
parameters. </li>
|
||
|
|
<li><em>Omissible</em>: The parameters can be omitted. When these parameters
|
||
|
|
are omitted, you must pass a null pointer.</li>
|
||
|
|
</ul>
|
||
|
|
<p>For OPM and ILE APIs, the values for all parameters that identify objects
|
||
|
|
on the system must be in *NAME (basic name) format, left-justified, uppercase,
|
||
|
|
and with valid special characters. (The *NAME format is a character string
|
||
|
|
that must begin with an alphabetic character (A through Z, $, #, or @) followed
|
||
|
|
by up to 9 characters (A through Z, 0 through 9, $, #, @, ), or _). The system
|
||
|
|
uses an object name as is, and it does not change or check the object name
|
||
|
|
before locating the object. This improves the performance of the API. An incorrect
|
||
|
|
name usually results in an <samp class="codeph">Object not found</samp> error.</p>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="ullinks">
|
||
|
|
<li class="ulchildlink"><strong><a href="conPassParm.htm">Passing parameters</a></strong><br />
|
||
|
|
In an OPM or ILE call, a parameter is an expression that represents a value that the calling application passes to the API specified in the call.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="conIOParm.htm">Input and output parameters</a></strong><br />
|
||
|
|
API parameters can be used for input or output. Some parameters contain both input and output fields; these are identified as input/output (I/O) parameters in the API parameter tables.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="conOffset.htm">Offset values and lengths</a></strong><br />
|
||
|
|
You can make use of the offset values and lengths returned by the API to step through the list when using an API.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="conOvD.htm">Offset versus displacement considerations for structures</a></strong><br />
|
||
|
|
You will find the terms offset and or displacement in some of the APIs. For example, the Retrieve Data Queue Message (QMHRDQM) API uses offset; the List Objects (QUSLOBJ) API uses displacement.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="error.htm">Error code parameter</a></strong><br />
|
||
|
|
An API error code parameter is a variable-length structure that is common to all of the system APIs.</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="relref"><strong>Related reference</strong><br />
|
||
|
|
<div><a href="opmIlecompare.htm" title="This topic gives an overview of how Original Program Model (OPM) APIs and Integrated Language Environment (ILE) APIs differ from each other. The ILE APIs include the UNIX-type APIs and the ILE CEE APIs, among others.">OPM and ILE API differences</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|