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

85 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="reference" />
<meta name="DC.Title" content="User spaces" />
<meta name="abstract" content="List APIs require a user space for returning information. A user space is an object consisting of a collection of bytes that can be used for storing any user-defined information." />
<meta name="description" content="List APIs require a user space for returning information. A user space is an object consisting of a collection of bytes that can be used for storing any user-defined information." />
<meta name="DC.Relation" scheme="URI" content="conUSRV.htm" />
<meta name="DC.Relation" scheme="URI" content="usfgeneral.htm" />
<meta name="DC.Relation" scheme="URI" content="usfcommonstructure.htm" />
<meta name="DC.Relation" scheme="URI" content="usfexample.htm" />
<meta name="DC.Relation" scheme="URI" content="usflistsection.htm" />
<meta name="DC.Relation" scheme="URI" content="listUserSpace.htm" />
<meta name="DC.Relation" scheme="URI" content="conReceiver.htm" />
<meta name="DC.Relation" scheme="URI" content="conReceiver.htm" />
<meta name="DC.Relation" scheme="URI" content="listOverview.htm" />
<meta name="DC.Relation" scheme="URI" content="listUserSpace.htm" />
<meta name="DC.Relation" scheme="URI" content="cmnKeysRPG.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="usf" />
<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>User spaces</title>
</head>
<body id="usf"><a name="usf"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">User spaces</h1>
<div><p>List APIs require a user space for returning information. A user
space is an object consisting of a collection of bytes that can be used for
storing any user-defined information.</p>
<div class="section"><p>Following are some of the advantages of using user spaces:</p>
<ul><li>User spaces can be automatically extendable.</li>
<li>User spaces can be shared across jobs.</li>
<li>User spaces can exist across IPLs.</li>
</ul>
<p>To provide a consistent design and use of the user space (*USRSPC)
objects, the list APIs use a common data structure. The list APIs are those
APIs that generate a list unique to that API. This includes any list API that
has a user space parameter, such as the List Spooled Files and List Objects
APIs.</p>
</div>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="usfgeneral.htm">General data structure</a></strong><br />
The list APIs use a general data structure.</li>
<li class="ulchildlink"><strong><a href="usfcommonstructure.htm">Common data structure formats</a></strong><br />
This topic shows the generic user space layout. Format 0100 shows
the format for an original program model (OPM) layout. Format 0300 shows the
format for an Integrated
Language Environment<sup>®</sup> (ILE) model layout. The fields are described in
detail after the table.</li>
<li class="ulchildlink"><strong><a href="usfexample.htm">Example: User space format</a></strong><br />
This example illustrates the format of a user space. This example does not contain all of the fields in the fixed portion of a user space.</li>
<li class="ulchildlink"><strong><a href="usflistsection.htm">List sections</a></strong><br />
Each list API provides a input parameter, header, and list data section.</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="conUSRV.htm" title="APIs that return information to a caller generally return the information in a user space (used by list APIs) or a receiver variable (used by retrieve APIs).">User spaces and receiver variables</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<div><a href="listUserSpace.htm" title="The list APIs require a user space for returning information.">User spaces for list APIs</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="listOverview.htm" title="List APIs return a list unique to a given API. The section discusses the characteristics of a list API and provides information that you should be aware of when you use list APIs.">List APIs overview</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="cmnKeysRPG.htm" title="This example shows the steps necessary to process keyed output from an API.">Example in OPM RPG: Using keys with List Spooled Files API</a></div>
</div>
</div>
</body>
</html>