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

185 lines
4.3 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>xdr_char()--Translate between Characters and Their XDR</title>
<!-- 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. -->
<!-- Begin Header Records ========================================== -->
<!-- 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>
<a name="Top_of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>xdr_char()--Translate between Characters and Their XDR</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;rpc/xdr.h&gt;
bool_t xdr_char(XDR *<em>xdrs</em>,
char *<em>cp</em>);
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QZNFTRPC<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>xdr_char()</strong> function is a filter primitive that
translates between C-language characters and their external representation.</p>
<p><strong>Note</strong>: Encoded characters are not packed and occupy 4 bytes
each. For strings of characters, consider using the <strong>xdr_string</strong>
function.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>xdrs</strong> &nbsp;(Input)&nbsp;</dt>
<dd>A pointer to the eXternal Data Representation (XDR) stream handle.<br>
<br>
</dd>
<dt><strong>cp</strong> &nbsp;(I/O)&nbsp;</dt>
<dd>A pointer to the character.</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 valign="top"><em>TRUE (1)</em></td>
<td valign="top">Successful</td>
</tr>
<tr>
<td valign="top"><em>FALSE (0)</em></td>
<td valign="top">Unsuccessful</td>
</tr>
</table>
<br>
<br>
<h3>Error Conditions</h3>
<p>None.</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">CPE3418 E</td>
<td width="85%" valign="top">Possible APAR condition or hardware failure.</td>
</tr>
<tr>
<td valign="top">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;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>xdr_char()</strong> is used:</p>
<pre>
#include &lt;stdio.h&gt;
#include &lt;xdr.h&gt;
typedef struct grades
{
char math; /* Each grade is 'A'..'D' */
char literature;
char geography;
char computers;
} grades ;
bool xdr_grades(XDR *xdrs, grades *p_grades)
{
if(!<strong>xdr_char</strong>(xdrs,&amp;(p_grades-&gt;math)))
return FALSE;
if(!<strong>xdr_char</strong>(xdrs,&amp;(p_grades-&gt;literature)))
return FALSE;
if(!<strong>xdr_char</strong>(xdrs,&amp;(p_grades-&gt;geography)))
return FALSE;
return <strong>xdr_char</strong>(xdrs,&amp;(p_grades-&gt;computers));
}
</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>