vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/html/structcmd_8h_source.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 Source File</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="headertitle">
  41 <div class="title">structcmd.h</div>  </div>
  42 </div><!--header-->
  43 <div class="contents">
  44 <a href="structcmd_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*! \file structcmd.h</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">    \brief A Documented file.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">    </span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">    Details.</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">/*! \def MAX(a,b)</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">    \brief A macro that returns the maximum of \a a and \a b.</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">   </span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">    Details.</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/*! \var typedef unsigned int UINT32</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">    \brief A type definition for a .</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    </span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">    Details.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">/*! \var int errno</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">    \brief Contains the last error code.</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">    \warning Not thread safe!</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">/*! \fn int open(const char *pathname,int flags)</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">    \brief Opens a file descriptor.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">    \param pathname The name of the descriptor.</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">    \param flags Opening flags.</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">/*! \fn int close(int fd)</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">    \brief Closes the file descriptor \a fd.</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">    \param fd The descriptor to close.</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">/*! \fn size_t write(int fd,const char *buf, size_t count)</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">    \brief Writes \a count bytes from \a buf to the filedescriptor \a fd.</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">    \param fd The descriptor to write to.</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">    \param buf The data buffer to write.</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">    \param count The number of bytes to write.</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">/*! \fn int read(int fd,char *buf,size_t count)</span></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">    \brief Read bytes from a file descriptor.</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">    \param fd The descriptor to read from.</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">    \param buf The buffer to read into.</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">    \param count The number of bytes to read.</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structcmd_8h.html#afa99ec4acc4ecb2dc3c2d05da15d0e3f">   51</a></span>&#160;<span class="preprocessor">#define MAX(a,b) (((a)&gt;(b))?(a):(b))</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structcmd_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">   52</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structcmd_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structcmd_8h.html#ad65a8842cc674e3ddf69355898c0ecbf">   53</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="structcmd_8h.html#ad65a8842cc674e3ddf69355898c0ecbf">errno</a>;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="keywordtype">int</span> <a class="code" href="structcmd_8h.html#a2c4414339f388561554c2deab11a1a07">open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *,<span class="keywordtype">int</span>);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keywordtype">int</span> <a class="code" href="structcmd_8h.html#ae152484c890a24e4d9b4980e7b965be0">close</a>(<span class="keywordtype">int</span>);</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="keywordtype">size_t</span> <a class="code" href="structcmd_8h.html#af2a3ea719b83f672637febdd87c36c36">write</a>(<span class="keywordtype">int</span>,<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="keywordtype">int</span> <a class="code" href="structcmd_8h.html#a9c7b76d5266903891c803132d51ccb90">read</a>(<span class="keywordtype">int</span>,<span class="keywordtype">char</span> *,<span class="keywordtype">size_t</span>);</div><div class="ttc" id="structcmd_8h_html_a2c4414339f388561554c2deab11a1a07"><div class="ttname"><a href="structcmd_8h.html#a2c4414339f388561554c2deab11a1a07">open</a></div><div class="ttdeci">int open(const char *, int)</div><div class="ttdoc">Opens a file descriptor. </div></div>
  45 <div class="ttc" id="structcmd_8h_html_af2a3ea719b83f672637febdd87c36c36"><div class="ttname"><a href="structcmd_8h.html#af2a3ea719b83f672637febdd87c36c36">write</a></div><div class="ttdeci">size_t write(int, const char *, size_t)</div><div class="ttdoc">Writes count bytes from buf to the filedescriptor fd. </div></div>
  46 <div class="ttc" id="structcmd_8h_html_ad65a8842cc674e3ddf69355898c0ecbf"><div class="ttname"><a href="structcmd_8h.html#ad65a8842cc674e3ddf69355898c0ecbf">errno</a></div><div class="ttdeci">int errno</div><div class="ttdoc">Contains the last error code. </div><div class="ttdef"><b>Definition:</b> structcmd.h:53</div></div>
  47 <div class="ttc" id="structcmd_8h_html_ae152484c890a24e4d9b4980e7b965be0"><div class="ttname"><a href="structcmd_8h.html#ae152484c890a24e4d9b4980e7b965be0">close</a></div><div class="ttdeci">int close(int)</div><div class="ttdoc">Closes the file descriptor fd. </div></div>
  48 <div class="ttc" id="structcmd_8h_html_a9c7b76d5266903891c803132d51ccb90"><div class="ttname"><a href="structcmd_8h.html#a9c7b76d5266903891c803132d51ccb90">read</a></div><div class="ttdeci">int read(int, char *, size_t)</div><div class="ttdoc">Read bytes from a file descriptor. </div></div>
  49 <div class="ttc" id="structcmd_8h_html_ae1e6edbbc26d6fbc71a90190d0266018"><div class="ttname"><a href="structcmd_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a></div><div class="ttdeci">unsigned int UINT32</div><div class="ttdoc">A type definition for a . </div><div class="ttdef"><b>Definition:</b> structcmd.h:52</div></div>
  50 </div><!-- fragment --></div><!-- contents -->
  51 <!-- start footer part -->
  52 <hr class="footer"/><address class="footer"><small>
  53 Generated by &#160;<a href="http://www.doxygen.org/index.html">
  54 <img class="footer" src="doxygen.png" alt="doxygen"/>
  55 </a> 1.8.12
  56 </small></address>
  57 </body>
  58 </html>