204 lines
4.7 KiB
HTML
204 lines
4.7 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>clnt_freeres()--Free Data Allocated by the RPC or XDR System</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 -->
|
|
<!-- RPCMST SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
|
|
<!-- RCHVMW2 on 7 Oct 1998 at 23:43:14 -->
|
|
<!-- Edited by Kersten Feb 02 -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
|
|
<!--Java sync-link-->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>clnt_freeres()--Free Data Allocated by the RPC or XDR System</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
Syntax<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<pre>
|
|
#include <rpc/rpc.h>
|
|
|
|
bool_t clnt_freeres(CLIENT *<em>clnt</em>,
|
|
const xdrproc_t <em>inproc</em>,
|
|
caddr_t <em>in</em>);
|
|
</pre>
|
|
|
|
<br>
|
|
Service Program Name: QZNFTRPC<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>clnt_freeres()</strong> function frees any data allocated by the
|
|
RPC or XDR system when it decoded the results of an RPC call.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
<dt><strong>clnt</strong> (Input) </dt>
|
|
|
|
<dd>A pointer to the client handle.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>inproc</strong> (Input) </dt>
|
|
|
|
<dd>XDR routine describing the results.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>in</strong> (Input) </dt>
|
|
|
|
<dd>(Input) The address of the results.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities</h3>
|
|
|
|
<p>No authorization is required.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>TRUE (1)</em></td>
|
|
<td align="left" valign="top">Successful</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>FALSE (0)</em></td>
|
|
<td align="left" valign="top">Unsuccessful</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>This function returns FALSE when the <em>in</em> parameter is NULL or an
|
|
exception has occurred. In case of an exception,
|
|
<strong>clnt_freeres()</strong> tries to set RPC_INTR in the client handle.
|
|
This status can be retrieved by a call to <strong>clnt_geterr()</strong>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF9872 E</td>
|
|
<td width="85%" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Example</h3>
|
|
|
|
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
|
|
for information pertaining to code examples.</p>
|
|
|
|
<p>The following example shows how <strong>clnt_freeres()</strong> is used:</p>
|
|
|
|
<pre>
|
|
#include <stdio.h>
|
|
#include <rpc/rpc.h>
|
|
|
|
...
|
|
|
|
u_long procnum;
|
|
CLIENT *clnt;
|
|
enum clnt_stat stat;
|
|
struct rpc_err client_error;
|
|
struct timeval timeout;
|
|
|
|
struct array_args{
|
|
unsigned int size;
|
|
char *data;
|
|
};
|
|
|
|
struct array_args args; /* Arg with buffer to send */
|
|
struct array_args result; /* Arg with buffer to receive */
|
|
|
|
...
|
|
|
|
/* Call the remote procedure that is associated with client */
|
|
|
|
...
|
|
|
|
stat = <strong>clnt_call</strong>(clnt, procnum, (xdrproc_t)xdr_array,
|
|
(char *)&args, (xdrproc_t)xdr_array,
|
|
(char *)&result, timeout);
|
|
if (stat != RPC_SUCCESS){
|
|
/* Failure on call */
|
|
if (result.data != (char *) NULL){
|
|
if(!<strong>clnt_freeres</strong>(clnt, (xdrproc_t)xdr_array,
|
|
(char *)&result))
|
|
/* <strong>clnt_freeres()</strong> failed */
|
|
|
|
...
|
|
|
|
}
|
|
...
|
|
}
|
|
|
|
</pre>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V4R2
|
|
|
|
<hr>
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"rpc1.htm">Remote Procedure Call (RPC) APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|
|
|