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">
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" />
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
17 <table cellspacing="0" cellpadding="0">
19 <tr style="height: 56px;">
20 <td id="projectalign" style="padding-left: 0.5em;">
21 <div id="projectname">Structural commands
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">
34 initMenu('',false,false,'search.php','Search');
37 <div id="main-nav"></div>
41 <a href="#define-members">Macros</a> |
42 <a href="#typedef-members">Typedefs</a> |
43 <a href="#func-members">Functions</a> |
44 <a href="#var-members">Variables</a> </div>
45 <div class="headertitle">
46 <div class="title">structcmd.h File Reference</div> </div>
48 <div class="contents">
51 <a href="#details">More...</a></p>
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>
57 <tr class="memitem:afa99ec4acc4ecb2dc3c2d05da15d0e3f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd_8h.html#afa99ec4acc4ecb2dc3c2d05da15d0e3f">MAX</a>(a, b)   (((a)>(b))?(a):(b))</td></tr>
58 <tr class="memdesc:afa99ec4acc4ecb2dc3c2d05da15d0e3f"><td class="mdescLeft"> </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"> </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 </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"> </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"> </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 </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"> </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"> </td></tr>
72 <tr class="memitem:ae152484c890a24e4d9b4980e7b965be0"><td class="memItemLeft" align="right" valign="top">int </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"> </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"> </td></tr>
75 <tr class="memitem:af2a3ea719b83f672637febdd87c36c36"><td class="memItemLeft" align="right" valign="top">size_t </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"> </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"> </td></tr>
78 <tr class="memitem:a9c7b76d5266903891c803132d51ccb90"><td class="memItemLeft" align="right" valign="top">int </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"> </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"> </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 </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"> </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"> </td></tr>
88 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
89 <div class="textblock"><p>A Documented file. </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">§ </a></span>MAX</h2>
96 <div class="memproto">
97 <table class="memname">
99 <td class="memname">#define MAX</td>
101 <td class="paramtype"> </td>
102 <td class="paramname">a, </td>
105 <td class="paramkey"></td>
107 <td class="paramtype"> </td>
108 <td class="paramname">b </td>
113 <td></td><td>   (((a)>(b))?(a):(b))</td>
116 </div><div class="memdoc">
118 <p>A macro that returns the maximum of <em>a</em> and <em>b</em>. </p>
123 <h2 class="groupheader">Typedef Documentation</h2>
124 <a id="ae1e6edbbc26d6fbc71a90190d0266018"></a>
125 <h2 class="memtitle"><span class="permalink"><a href="#ae1e6edbbc26d6fbc71a90190d0266018">§ </a></span>UINT32</h2>
127 <div class="memitem">
128 <div class="memproto">
129 <table class="memname">
131 <td class="memname">typedef unsigned int <a class="el" href="structcmd_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a></td>
134 </div><div class="memdoc">
136 <p>A type definition for a . </p>
141 <h2 class="groupheader">Function Documentation</h2>
142 <a id="ae152484c890a24e4d9b4980e7b965be0"></a>
143 <h2 class="memtitle"><span class="permalink"><a href="#ae152484c890a24e4d9b4980e7b965be0">§ </a></span>close()</h2>
145 <div class="memitem">
146 <div class="memproto">
147 <table class="memname">
149 <td class="memname">int close </td>
151 <td class="paramtype">int </td>
152 <td class="paramname"><em>fd</em></td><td>)</td>
156 </div><div class="memdoc">
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>
168 <a id="a2c4414339f388561554c2deab11a1a07"></a>
169 <h2 class="memtitle"><span class="permalink"><a href="#a2c4414339f388561554c2deab11a1a07">§ </a></span>open()</h2>
171 <div class="memitem">
172 <div class="memproto">
173 <table class="memname">
175 <td class="memname">int open </td>
177 <td class="paramtype">const char * </td>
178 <td class="paramname"><em>pathname</em>, </td>
181 <td class="paramkey"></td>
183 <td class="paramtype">int </td>
184 <td class="paramname"><em>flags</em> </td>
192 </div><div class="memdoc">
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>
205 <a id="a9c7b76d5266903891c803132d51ccb90"></a>
206 <h2 class="memtitle"><span class="permalink"><a href="#a9c7b76d5266903891c803132d51ccb90">§ </a></span>read()</h2>
208 <div class="memitem">
209 <div class="memproto">
210 <table class="memname">
212 <td class="memname">int read </td>
214 <td class="paramtype">int </td>
215 <td class="paramname"><em>fd</em>, </td>
218 <td class="paramkey"></td>
220 <td class="paramtype">char * </td>
221 <td class="paramname"><em>buf</em>, </td>
224 <td class="paramkey"></td>
226 <td class="paramtype">size_t </td>
227 <td class="paramname"><em>count</em> </td>
235 </div><div class="memdoc">
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>
249 <a id="af2a3ea719b83f672637febdd87c36c36"></a>
250 <h2 class="memtitle"><span class="permalink"><a href="#af2a3ea719b83f672637febdd87c36c36">§ </a></span>write()</h2>
252 <div class="memitem">
253 <div class="memproto">
254 <table class="memname">
256 <td class="memname">size_t write </td>
258 <td class="paramtype">int </td>
259 <td class="paramname"><em>fd</em>, </td>
262 <td class="paramkey"></td>
264 <td class="paramtype">const char * </td>
265 <td class="paramname"><em>buf</em>, </td>
268 <td class="paramkey"></td>
270 <td class="paramtype">size_t </td>
271 <td class="paramname"><em>count</em> </td>
279 </div><div class="memdoc">
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>
293 <h2 class="groupheader">Variable Documentation</h2>
294 <a id="ad65a8842cc674e3ddf69355898c0ecbf"></a>
295 <h2 class="memtitle"><span class="permalink"><a href="#ad65a8842cc674e3ddf69355898c0ecbf">§ </a></span>errno</h2>
297 <div class="memitem">
298 <div class="memproto">
299 <table class="memname">
301 <td class="memname">int errno</td>
304 </div><div class="memdoc">
306 <p>Contains the last error code. </p>
307 <dl class="section warning"><dt>Warning</dt><dd>Not thread safe! </dd></dl>
311 </div><!-- contents -->
312 <!-- start footer part -->
313 <hr class="footer"/><address class="footer"><small>
314 Generated by  <a href="http://www.doxygen.org/index.html">
315 <img class="footer" src="doxygen.png" alt="doxygen"/>