<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Discard Heap (CEEDSHP) API</title>
<!-- Begin Header Records  ========================================== -->
<!-- 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.                         -->
<!-- Change History:                                                  -->
<!--    YYMMDD USERID Change description                              -->
<!-- ILE8A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at   -->
<!-- RCHVMX on 25 Feb 1999 at 15:15:15                                -->
<!-- End Header Records  -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>

<a name="Top_Of_Page"></a> 

<h2>Discard Heap (CEEDSHP) API</h2>

<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;Required Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">

<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">heap_id</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">INT4</td>
</tr>
</table>

<br>
&nbsp;&nbsp;Omissible Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">

<tr>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="50%">fc</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">FEEDBACK</td>
</tr>
</table>

<br>
&nbsp;&nbsp;Service Program Name: QLEAWI<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>

<p>The Discard Heap (CEEDSHP) API deletes an existing heap.</p>

<!-- Please NOTE:  DO NOT DELETE THIS SECTION if this API has no authorities and locks.  -->
<!-- Instead, use the commented out coding below to indicate NONE.                       -->
<h3>Authorities and Locks</h3>

<!-- Use this if there are no authorities and locks.                                     -->
<p>None.</p>

<br>
 
<h3>Required Parameter</h3>

<dl>
<dt><strong>heap_id (input)</strong></dt>

<dd>The heap identifier of the heap to be discarded.</dd>
</dl>

<br>
<h3>Omissible Parameter</h3>

<dl>
<dt><strong>fc (output)</strong></dt>

<dd>A 12-byte feedback code.</dd>
</dl>

<br>
<h3>Feedback Codes and Conditions</h3>

<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">CEE0000</td>
<td align="left" valign="top">The API completed successfully</td>
</tr>

<tr>
<td align="left" valign="top">Severity: 00</td>
<td align="left" valign="top">&nbsp;</td>
</tr>

<tr>
<td align="left" valign="top">CEE0803</td>
<td align="left" valign="top">The heap identifier does not match any existing
heap</td>
</tr>

<tr>
<td align="left" valign="top">Severity: 30</td>
<td align="left" valign="top">&nbsp;</td>
</tr>

<tr>
<td align="left" valign="top">CEE0812</td>
<td align="left" valign="top">The basic initial heap cannot be marked and
discarded</td>
</tr>

<tr>
<td align="left" valign="top">Severity: 30</td>
<td align="left" valign="top">&nbsp;</td>
</tr>

<tr>
<td align="left" valign="top">CEE0850</td>
<td align="left" valign="top">The heap cannot be marked</td>
</tr>

<tr>
<td align="left" valign="top">Severity: 30</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>

<br>
<h3>Usage Notes</h3>

<ul>
<li>A <em>heap_id</em> of 0 is not valid. This is the heap identifier of the
default heap; it cannot be discarded.</li>

<li>After this call, there may still be pointers to storage that had been
allocated from this heap. Their use can cause unpredictable or erroneous
results.</li>
</ul>

<br>
<hr>
API introduced: V2R3

<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"ile1a1.htm">ILE CEE APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>