1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Structural commands: structcmd.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Structural commands
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">structcmd.h</div> </div>
</div><!--header-->
<div class="contents">
<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> <span class="comment">/*! \file structcmd.h</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> \brief A Documented file.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> </span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Details.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">*/</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/*! \def MAX(a,b)</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <span class="comment"> </span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Details.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">*/</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/*! \var typedef unsigned int UINT32</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> \brief A type definition for a .</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> </span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> Details.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/*! \var int errno</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> \brief Contains the last error code.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> \warning Not thread safe!</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">*/</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <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> <span class="comment"> \brief Opens a file descriptor.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> \param pathname The name of the descriptor.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> \param flags Opening flags.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">*/</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/*! \fn int close(int fd)</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> \brief Closes the file descriptor \a fd.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> \param fd The descriptor to close.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">*/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <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> <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> <span class="comment"> \param fd The descriptor to write to.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> \param buf The data buffer to write.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <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> <span class="comment">*/</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <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> <span class="comment"> \brief Read bytes from a file descriptor.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> \param fd The descriptor to read from.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> \param buf The buffer to read into.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <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> <span class="comment">*/</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structcmd_8h.html#afa99ec4acc4ecb2dc3c2d05da15d0e3f"> 51</a></span> <span class="preprocessor">#define MAX(a,b) (((a)>(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> <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> <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> <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> <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> <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> <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>
<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>
<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>
<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>
<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>
<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>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|
