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

86 lines
7.0 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="task" />
<meta name="DC.Title" content="Continuation handle" />
<meta name="abstract" content="Some APIs that return information offer a continuation handle." />
<meta name="description" content="Some APIs that return information offer a continuation handle." />
<meta name="DC.Relation" scheme="URI" content="concept.htm" />
<meta name="DC.Relation" scheme="URI" content="ileRetrieveILEC.htm" />
<meta name="DC.Relation" scheme="URI" content="listGeneral.htm" />
<meta name="DC.Relation" scheme="URI" content="ileRetrieveILEC.htm" />
<meta name="DC.Relation" scheme="URI" content="ileRetrieveCOBOL.htm" />
<meta name="DC.Relation" scheme="URI" content="ileRetrieveILECOBOL.htm" />
<meta name="DC.Relation" scheme="URI" content="ileRetrieveRPG.htm" />
<meta name="DC.Relation" scheme="URI" content="ileRetrieveILERPG.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="conContinuation" />
<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>Continuation handle</title>
</head>
<body id="conContinuation"><a name="conContinuation"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Continuation handle</h1>
<div><p>Some APIs that return information offer a continuation handle.</p>
<div class="section"><p>A <em>continuation handle</em> is a value that is passed between
a high-level language program and an API. It is used to mark the last value
put in either the receiver variable or the user space. When a call to an API
is made and the API has more information to return than what could fit in
the receiver variable or user space provided by the caller, the API returns
a continuation handle. If a continuation handle is returned to the caller
because there is more information to return, the caller can then call the
API again and pass the continuation handle that was returned. The API continues
to return information from the point that it left off on the call that generated
the continuation handle.</p>
<p>When you use the continuation handle parameter,
that is the only parameter that can change. All other parameters must appear
as they did on the call to the API that generated the continuation handle
to obtain predictable results.</p>
</div>
</div>
<div>
<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="ileRetrieveILEC.htm" title="This program retrieves exit point and exit program information. After retrieving the exit point information, the program resolves to each associated exit program and calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.">Example in ILE C: Retrieve exit point and exit program information</a></div>
<div><a href="listGeneral.htm" title="Describes some of the more important fields that comprise the general data structure.">List Object API general data structure</a></div>
<div><a href="ileRetrieveCOBOL.htm" title="This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.">Example in OPM COBOL: Retrieve exit point and exit program information</a></div>
<div><a href="ileRetrieveILECOBOL.htm" title="This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.">Example in ILE COBOL: Retrieve exit point and exit program information</a></div>
<div><a href="ileRetrieveRPG.htm" title="This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.">Example in OPM RPG: Retrieve exit point and exit program information</a></div>
<div><a href="ileRetrieveILERPG.htm" title="This program retrieves exit point and exit program information. After retrieving the exit point information, the program calls each, exit program. The Retrieve Exit Information API returns a continuation handle when it has more information to return than what fits in the receiver variable.">Example in ILE RPG: Retrieve exit point and exit program information</a></div>
</div>
</div><div class="nested1" xml:lang="en-us" id="continuationhandle"><a name="continuationhandle"><!-- --></a><h2 class="topictitle2">Using a continuation handle</h2>
<div><div class="section">To make use of a continuation handle, do the following:</div>
<ol><li><span>Blank out the continuation handle to let the API know that this
is a first attempt at the retrieve operation.</span></li>
<li><span>Call the API to retrieve the information.</span></li>
<li><span>Make use of the information returned.</span></li>
<li><span>If the continuation handle field in the receiver variable is not
set to blanks, do the following steps until the continuation handle equals
blanks: </span><ol type="a"><li><span>Copy the continuation handle from the receiver variable to the
continuation handle parameter.</span></li>
<li><span>Call the API again by using the continuation handle that is
returned. Keep all other parameters the same as the original API call.</span></li>
</ol>
</li>
</ol>
</div>
</div>
</body>
</html>