ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qp2free.htm

135 lines
3.0 KiB
HTML

<!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>Qp2free()--Free i5/OS PASE Heap Memory</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 -->
<!-- Edited by Kersten Jan 02 -->
<!-- Created by V2DCIJB on 23 Nov 1999 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Qp2free()--Free i5/OS PASE Heap Memory</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;qp2user.h&gt;
int Qp2free(void *mem);
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QP2USER<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>Qp2free() frees an i5/OS PASE heap memory allocation by calling the i5/OS
PASE free() function.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>mem</strong></dt>
<dd>(Input) A pointer to the start of the i5/OS PASE memory allocation to be
freed.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>None.</p>
<br>
<h3>Return Value</h3>
<p>The function result is zero for normal completion, or -1 with an error
indicated in ILE <strong>errno</strong> that is ususally one of the
following:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EPERM</em></td>
<td align="left" valign="top">An error occurred attempting to call an i5/OS
PASE function.<br>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>ETERM</em></td>
<td align="left" valign="top">i5/OS PASE is terminating.<br>
<br>
</td>
</tr>
</table>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="http://www.ibm.com/servers/aix/library/" target="blank">i5/OS
PASE free()--See AIX documentation</a><img src="www.gif" alt="Link outside Information Center"><br>
<br>
</li>
<li><a href="qp2errnop.htm">Qp2errnop()--Retrieve i5/OS PASE errno
Pointer</a><br>
<br>
</li>
<li><a href="qp2runpase.htm">Qp2RunPase()--Run an i5/OS PASE Program</a></li>
</ul>
<br>
<hr>
API introduced: V5R2
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"pase1.htm">i5/OS PASE APIs</a> | <a href="aplist.htm">APIs by category</a>
</td>
</tr>
</table>
</center>
</body>
</html>