67 lines
4.1 KiB
HTML
67 lines
4.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="Keyed interface" />
|
||
|
|
<meta name="abstract" content="Some APIs have a keyed interface for selecting what information you want returned. A keyed interface allows the user of the API to provide information to the API through the use of keys." />
|
||
|
|
<meta name="description" content="Some APIs have a keyed interface for selecting what information you want returned. A keyed interface allows the user of the API to provide information to the API through the use of keys." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="conReceiver.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="receiverkeyed" />
|
||
|
|
<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>Keyed interface</title>
|
||
|
|
</head>
|
||
|
|
<body id="receiverkeyed"><a name="receiverkeyed"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Keyed interface</h1>
|
||
|
|
<div><p>Some APIs have a keyed interface for selecting what information
|
||
|
|
you want returned. A <em>keyed interface</em> allows the user of the API to
|
||
|
|
provide information to the API through the use of keys.</p>
|
||
|
|
<div class="section"><p>Keys are API-specific values that inform the API
|
||
|
|
that a certain function should be performed. Keys also are used to pass information
|
||
|
|
to an API or to retrieve information from an API.</p>
|
||
|
|
<p>Through the use of
|
||
|
|
keys, you can be more selective; you can choose one item or a number of items
|
||
|
|
rather than all of them. For example, using the List Job (QUSLJOB) API, you
|
||
|
|
can receive selected information about a job based on the keys that you specify.
|
||
|
|
If you want job information about the output queue priority, you only need
|
||
|
|
to specify the output queue priority key.</p>
|
||
|
|
<p>The keys are typically supplied
|
||
|
|
to an API and are passed to the API using a variable-length record (there
|
||
|
|
are some exceptions). A <em>variable-length record</em> is a collection of information
|
||
|
|
that specifies the key being used and the data that is associated with the
|
||
|
|
key. If a given structure contains binary values, it must be 4-byte aligned. </p>
|
||
|
|
<p>Some
|
||
|
|
APIs that use variable-length records in addition to the List Job API are
|
||
|
|
the Change Object Description (QLICOBJD) API and the Register Exit Point (QUSRGPT,
|
||
|
|
QusRegisterExitPoint) API. You can use the appropriate include file in member
|
||
|
|
QUS in the system include (QSYSINC) library when you have variable-length
|
||
|
|
records as either input or output.</p>
|
||
|
|
<p>A keyed interface provides an easy-to-use
|
||
|
|
means for later enhancing an API without affecting the user who chooses not
|
||
|
|
to use the enhancements. For examples that use a keyed interface, see Example:
|
||
|
|
Using keys with List Spooled Files API and Example: Keyed interface using
|
||
|
|
ILE APIs.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <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>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|