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

144 lines
3.5 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>rapi_fmt_flowspec()--Format a RAPI Flowspec</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. -->
<!-- Created by John Hall for V5R1-->
<!-- Change history: -->
<!-- 030522 LESMITH: D3255.1 public authority should be *EXCLUDE-->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>rapi_fmt_flowspec()--Format a RAPI Flowspec</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;rapi.h&gt;
void rapi_fmt_flowspec(
rapi_flowspec_t *pFlowspec,
char *pBuffer,
int size )
</pre>
<br>
&nbsp;&nbsp;Service program name: QSYS/QTOQRAPI<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default public authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>rapi_fmt_flowspec()</strong> API formats a RAPI Flowspec into a
string suitable for printing by converting the RAPI flowspec information that
has been passed to the API into a character string in the buffer that was
passed to the API. The flowspec defines the QoS that is to be provided to the
data flow. The output string is truncated if the length of the string exceeds
the buffer size.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong><em>pFlowspec</em></strong></dt>
<dd>(Input) Required<br>
A pointer to the flowspec to be formatted.<br>
<br>
</dd>
<dt><strong><em>pBuffer</em></strong></dt>
<dd>(Input/Output) Required<br>
A pointer to the buffer to be used.<br>
<br>
</dd>
<dt><strong><em>size</em></strong></dt>
<dd>(Input) Required<br>
The length of the supplied buffer.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>None.</p>
<br>
<h3>Return Value</h3>
<p>None.</p>
<br>
<h3>Error Conditions</h3>
<p>None.</p>
<br>
<h3>Usage Notes</h3>
<p>This API can be used to format the contents of the Flowspec information that
has been passed to the API into a string that can be displayed at the local
output device.</p>
<br>
<h3>Related Information</h3>
<p>For a description of the RSVP protocol, see RFC 2205 on the RFC Pages for <a
href="http://www.ietf.org/rfc.html">The Internet Engineering Task
Force</a>.<img src="www.gif" alt="Link outside Information Center"></p>
<p>Complete documentation of the RAPI APIs can be found at <a href=
"http://www.opengroup.org/publications/catalog/c809.htm">The Open
Group</a>.<img src="www.gif" alt="Link outside Information Center"></p>
<br>
<hr>
API introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a> </td>
</tr>
</table></center>
</body>
</html>