vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/html/structcmd_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Structural commands: structcmd.h File Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">Structural commands
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.12 -->
  30 <script type="text/javascript" src="menudata.js"></script>
  31 <script type="text/javascript" src="menu.js"></script>
  32 <script type="text/javascript">
  33 $(function() {
  34   initMenu('',false,false,'search.php','Search');
  35 });
  36 </script>
  37 <div id="main-nav"></div>
  38 </div><!-- top -->
  39 <div class="header">
  40   <div class="summary">
  41 <a href="#define-members">Macros</a> &#124;
  42 <a href="#typedef-members">Typedefs</a> &#124;
  43 <a href="#func-members">Functions</a> &#124;
  44 <a href="#var-members">Variables</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">structcmd.h File Reference</div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p>A Documented file.
  51 <a href="#details">More...</a></p>
  52
  53 <p><a href="structcmd_8h_source.html">Go to the source code of this file.</a></p>
  54 <table class="memberdecls">
  55 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  56 Macros</h2></td></tr>
  57 <tr class="memitem:afa99ec4acc4ecb2dc3c2d05da15d0e3f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#afa99ec4acc4ecb2dc3c2d05da15d0e3f">MAX</a>(a,  b)&#160;&#160;&#160;(((a)&gt;(b))?(a):(b))</td></tr>
  58 <tr class="memdesc:afa99ec4acc4ecb2dc3c2d05da15d0e3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A macro that returns the maximum of <em>a</em> and <em>b</em>.  <a href="#afa99ec4acc4ecb2dc3c2d05da15d0e3f">More...</a><br /></td></tr>
  59 <tr class="separator:afa99ec4acc4ecb2dc3c2d05da15d0e3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60 </table><table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  62 Typedefs</h2></td></tr>
  63 <tr class="memitem:ae1e6edbbc26d6fbc71a90190d0266018"><td class="memItemLeft" align="right" valign="top">typedef unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a></td></tr>
  64 <tr class="memdesc:ae1e6edbbc26d6fbc71a90190d0266018"><td class="mdescLeft">&#160;</td><td class="mdescRight">A type definition for a .  <a href="#ae1e6edbbc26d6fbc71a90190d0266018">More...</a><br /></td></tr>
  65 <tr class="separator:ae1e6edbbc26d6fbc71a90190d0266018"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 </table><table class="memberdecls">
  67 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  68 Functions</h2></td></tr>
  69 <tr class="memitem:a2c4414339f388561554c2deab11a1a07"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#a2c4414339f388561554c2deab11a1a07">open</a> (const char *, int)</td></tr>
  70 <tr class="memdesc:a2c4414339f388561554c2deab11a1a07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a file descriptor.  <a href="#a2c4414339f388561554c2deab11a1a07">More...</a><br /></td></tr>
  71 <tr class="separator:a2c4414339f388561554c2deab11a1a07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:ae152484c890a24e4d9b4980e7b965be0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#ae152484c890a24e4d9b4980e7b965be0">close</a> (int)</td></tr>
  73 <tr class="memdesc:ae152484c890a24e4d9b4980e7b965be0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the file descriptor <em>fd</em>.  <a href="#ae152484c890a24e4d9b4980e7b965be0">More...</a><br /></td></tr>
  74 <tr class="separator:ae152484c890a24e4d9b4980e7b965be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:af2a3ea719b83f672637febdd87c36c36"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#af2a3ea719b83f672637febdd87c36c36">write</a> (int, const char *, size_t)</td></tr>
  76 <tr class="memdesc:af2a3ea719b83f672637febdd87c36c36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes <em>count</em> bytes from <em>buf</em> to the filedescriptor <em>fd</em>.  <a href="#af2a3ea719b83f672637febdd87c36c36">More...</a><br /></td></tr>
  77 <tr class="separator:af2a3ea719b83f672637febdd87c36c36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:a9c7b76d5266903891c803132d51ccb90"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#a9c7b76d5266903891c803132d51ccb90">read</a> (int, char *, size_t)</td></tr>
  79 <tr class="memdesc:a9c7b76d5266903891c803132d51ccb90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read bytes from a file descriptor.  <a href="#a9c7b76d5266903891c803132d51ccb90">More...</a><br /></td></tr>
  80 <tr class="separator:a9c7b76d5266903891c803132d51ccb90"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 </table><table class="memberdecls">
  82 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  83 Variables</h2></td></tr>
  84 <tr class="memitem:ad65a8842cc674e3ddf69355898c0ecbf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#ad65a8842cc674e3ddf69355898c0ecbf">errno</a></td></tr>
  85 <tr class="memdesc:ad65a8842cc674e3ddf69355898c0ecbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the last error code.  <a href="#ad65a8842cc674e3ddf69355898c0ecbf">More...</a><br /></td></tr>
  86 <tr class="separator:ad65a8842cc674e3ddf69355898c0ecbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 </table>
  88 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  89 <div class="textblock"><p>A Documented file. </p>
  90 <p>Details. </p>
  91 </div><h2 class="groupheader">Macro Definition Documentation</h2>
  92 <a id="afa99ec4acc4ecb2dc3c2d05da15d0e3f"></a>
  93 <h2 class="memtitle"><span class="permalink"><a href="#afa99ec4acc4ecb2dc3c2d05da15d0e3f">&sect;&nbsp;</a></span>MAX</h2>
  94
  95 <div class="memitem">
  96 <div class="memproto">
  97       <table class="memname">
  98         <tr>
  99           <td class="memname">#define MAX</td>
 100           <td>(</td>
 101           <td class="paramtype">&#160;</td>
 102           <td class="paramname">a, </td>
 103         </tr>
 104         <tr>
 105           <td class="paramkey"></td>
 106           <td></td>
 107           <td class="paramtype">&#160;</td>
 108           <td class="paramname">b&#160;</td>
 109         </tr>
 110         <tr>
 111           <td></td>
 112           <td>)</td>
 113           <td></td><td>&#160;&#160;&#160;(((a)&gt;(b))?(a):(b))</td>
 114         </tr>
 115       </table>
 116 </div><div class="memdoc">
 117
 118 <p>A macro that returns the maximum of <em>a</em> and <em>b</em>. </p>
 119 <p>Details. </p>
 120
 121 </div>
 122 </div>
 123 <h2 class="groupheader">Typedef Documentation</h2>
 124 <a id="ae1e6edbbc26d6fbc71a90190d0266018"></a>
 125 <h2 class="memtitle"><span class="permalink"><a href="#ae1e6edbbc26d6fbc71a90190d0266018">&sect;&nbsp;</a></span>UINT32</h2>
 126
 127 <div class="memitem">
 128 <div class="memproto">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname">typedef unsigned int <a class="el" href="structcmd_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a></td>
 132         </tr>
 133       </table>
 134 </div><div class="memdoc">
 135
 136 <p>A type definition for a . </p>
 137 <p>Details. </p>
 138
 139 </div>
 140 </div>
 141 <h2 class="groupheader">Function Documentation</h2>
 142 <a id="ae152484c890a24e4d9b4980e7b965be0"></a>
 143 <h2 class="memtitle"><span class="permalink"><a href="#ae152484c890a24e4d9b4980e7b965be0">&sect;&nbsp;</a></span>close()</h2>
 144
 145 <div class="memitem">
 146 <div class="memproto">
 147       <table class="memname">
 148         <tr>
 149           <td class="memname">int close </td>
 150           <td>(</td>
 151           <td class="paramtype">int&#160;</td>
 152           <td class="paramname"><em>fd</em></td><td>)</td>
 153           <td></td>
 154         </tr>
 155       </table>
 156 </div><div class="memdoc">
 157
 158 <p>Closes the file descriptor <em>fd</em>. </p>
 159 <dl class="params"><dt>Parameters</dt><dd>
 160   <table class="params">
 161     <tr><td class="paramname">fd</td><td>The descriptor to close. </td></tr>
 162   </table>
 163   </dd>
 164 </dl>
 165
 166 </div>
 167 </div>
 168 <a id="a2c4414339f388561554c2deab11a1a07"></a>
 169 <h2 class="memtitle"><span class="permalink"><a href="#a2c4414339f388561554c2deab11a1a07">&sect;&nbsp;</a></span>open()</h2>
 170
 171 <div class="memitem">
 172 <div class="memproto">
 173       <table class="memname">
 174         <tr>
 175           <td class="memname">int open </td>
 176           <td>(</td>
 177           <td class="paramtype">const char *&#160;</td>
 178           <td class="paramname"><em>pathname</em>, </td>
 179         </tr>
 180         <tr>
 181           <td class="paramkey"></td>
 182           <td></td>
 183           <td class="paramtype">int&#160;</td>
 184           <td class="paramname"><em>flags</em>&#160;</td>
 185         </tr>
 186         <tr>
 187           <td></td>
 188           <td>)</td>
 189           <td></td><td></td>
 190         </tr>
 191       </table>
 192 </div><div class="memdoc">
 193
 194 <p>Opens a file descriptor. </p>
 195 <dl class="params"><dt>Parameters</dt><dd>
 196   <table class="params">
 197     <tr><td class="paramname">pathname</td><td>The name of the descriptor. </td></tr>
 198     <tr><td class="paramname">flags</td><td>Opening flags. </td></tr>
 199   </table>
 200   </dd>
 201 </dl>
 202
 203 </div>
 204 </div>
 205 <a id="a9c7b76d5266903891c803132d51ccb90"></a>
 206 <h2 class="memtitle"><span class="permalink"><a href="#a9c7b76d5266903891c803132d51ccb90">&sect;&nbsp;</a></span>read()</h2>
 207
 208 <div class="memitem">
 209 <div class="memproto">
 210       <table class="memname">
 211         <tr>
 212           <td class="memname">int read </td>
 213           <td>(</td>
 214           <td class="paramtype">int&#160;</td>
 215           <td class="paramname"><em>fd</em>, </td>
 216         </tr>
 217         <tr>
 218           <td class="paramkey"></td>
 219           <td></td>
 220           <td class="paramtype">char *&#160;</td>
 221           <td class="paramname"><em>buf</em>, </td>
 222         </tr>
 223         <tr>
 224           <td class="paramkey"></td>
 225           <td></td>
 226           <td class="paramtype">size_t&#160;</td>
 227           <td class="paramname"><em>count</em>&#160;</td>
 228         </tr>
 229         <tr>
 230           <td></td>
 231           <td>)</td>
 232           <td></td><td></td>
 233         </tr>
 234       </table>
 235 </div><div class="memdoc">
 236
 237 <p>Read bytes from a file descriptor. </p>
 238 <dl class="params"><dt>Parameters</dt><dd>
 239   <table class="params">
 240     <tr><td class="paramname">fd</td><td>The descriptor to read from. </td></tr>
 241     <tr><td class="paramname">buf</td><td>The buffer to read into. </td></tr>
 242     <tr><td class="paramname">count</td><td>The number of bytes to read. </td></tr>
 243   </table>
 244   </dd>
 245 </dl>
 246
 247 </div>
 248 </div>
 249 <a id="af2a3ea719b83f672637febdd87c36c36"></a>
 250 <h2 class="memtitle"><span class="permalink"><a href="#af2a3ea719b83f672637febdd87c36c36">&sect;&nbsp;</a></span>write()</h2>
 251
 252 <div class="memitem">
 253 <div class="memproto">
 254       <table class="memname">
 255         <tr>
 256           <td class="memname">size_t write </td>
 257           <td>(</td>
 258           <td class="paramtype">int&#160;</td>
 259           <td class="paramname"><em>fd</em>, </td>
 260         </tr>
 261         <tr>
 262           <td class="paramkey"></td>
 263           <td></td>
 264           <td class="paramtype">const char *&#160;</td>
 265           <td class="paramname"><em>buf</em>, </td>
 266         </tr>
 267         <tr>
 268           <td class="paramkey"></td>
 269           <td></td>
 270           <td class="paramtype">size_t&#160;</td>
 271           <td class="paramname"><em>count</em>&#160;</td>
 272         </tr>
 273         <tr>
 274           <td></td>
 275           <td>)</td>
 276           <td></td><td></td>
 277         </tr>
 278       </table>
 279 </div><div class="memdoc">
 280
 281 <p>Writes <em>count</em> bytes from <em>buf</em> to the filedescriptor <em>fd</em>. </p>
 282 <dl class="params"><dt>Parameters</dt><dd>
 283   <table class="params">
 284     <tr><td class="paramname">fd</td><td>The descriptor to write to. </td></tr>
 285     <tr><td class="paramname">buf</td><td>The data buffer to write. </td></tr>
 286     <tr><td class="paramname">count</td><td>The number of bytes to write. </td></tr>
 287   </table>
 288   </dd>
 289 </dl>
 290
 291 </div>
 292 </div>
 293 <h2 class="groupheader">Variable Documentation</h2>
 294 <a id="ad65a8842cc674e3ddf69355898c0ecbf"></a>
 295 <h2 class="memtitle"><span class="permalink"><a href="#ad65a8842cc674e3ddf69355898c0ecbf">&sect;&nbsp;</a></span>errno</h2>
 296
 297 <div class="memitem">
 298 <div class="memproto">
 299       <table class="memname">
 300         <tr>
 301           <td class="memname">int errno</td>
 302         </tr>
 303       </table>
 304 </div><div class="memdoc">
 305
 306 <p>Contains the last error code. </p>
 307 <dl class="section warning"><dt>Warning</dt><dd>Not thread safe! </dd></dl>
 308
 309 </div>
 310 </div>
 311 </div><!-- contents -->
 312 <!-- start footer part -->
 313 <hr class="footer"/><address class="footer"><small>
 314 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 315 <img class="footer" src="doxygen.png" alt="doxygen"/>
 316 </a> 1.8.12
 317 </small></address>
 318 </body>
 319 </html>