Mercurial > hg > ucx / file comparison

comparison: docs/api-2.1/structUcxProperties.html

docs/api-2.1/structUcxProperties.html

changeset 390
d345541018fa
equal deleted inserted replaced
389:92e482410453 390:d345541018fa
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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>ucx: UcxProperties Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td id="projectlogo"><img alt="Logo" src="uaplogo.png"/></td>
24 <td id="projectalign" style="padding-left: 0.5em;">
25 <div id="projectname">ucx
26 </div>
27 <div id="projectbrief">UAP Common Extensions</div>
28 </td>
29 </tr>
30 </tbody>
31 </table>
32 </div>
33 <!-- end header part -->
34 <!-- Generated by Doxygen 1.8.13 -->
35 <script type="text/javascript">
36 var searchBox = new SearchBox("searchBox", "search",false,'Search');
37 </script>
38 <script type="text/javascript" src="menudata.js"></script>
39 <script type="text/javascript" src="menu.js"></script>
40 <script type="text/javascript">
41 $(function() {
42 initMenu('',true,false,'search.php','Search');
43 $(document).ready(function() { init_search(); });
44 });
45 </script>
46 <div id="main-nav"></div>
47 <!-- window showing the filter options -->
48 <div id="MSearchSelectWindow"
49 onmouseover="return searchBox.OnSearchSelectShow()"
50 onmouseout="return searchBox.OnSearchSelectHide()"
51 onkeydown="return searchBox.OnSearchSelectKey(event)">
52 </div>
53
54 <!-- iframe showing the search results (closed by default) -->
55 <div id="MSearchResultsWindow">
56 <iframe src="javascript:void(0)" frameborder="0"
57 name="MSearchResults" id="MSearchResults">
58 </iframe>
59 </div>
60
61 </div><!-- top -->
62 <div class="header">
63 <div class="summary">
64 <a href="#pub-attribs">Data Fields</a> </div>
65 <div class="headertitle">
66 <div class="title">UcxProperties Struct Reference</div> </div>
67 </div><!--header-->
68 <div class="contents">
69
70 <p><a class="el" href="structUcxProperties.html" title="UcxProperties object for parsing properties data. ">UcxProperties</a> object for parsing properties data.
71 <a href="structUcxProperties.html#details">More...</a></p>
72
73 <p><code>#include &lt;<a class="el" href="properties_8h_source.html">properties.h</a>&gt;</code></p>
74 <table class="memberdecls">
75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
76 Data Fields</h2></td></tr>
77 <tr class="memitem:a6bb4d29686df41a0f42641ee15232bfd"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a6bb4d29686df41a0f42641ee15232bfd">buffer</a></td></tr>
78 <tr class="memdesc:a6bb4d29686df41a0f42641ee15232bfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input buffer (don't set manually). <a href="#a6bb4d29686df41a0f42641ee15232bfd">More...</a><br /></td></tr>
79 <tr class="separator:a6bb4d29686df41a0f42641ee15232bfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:a4e7524434525267e29f493a25dcca6b5"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a4e7524434525267e29f493a25dcca6b5">buflen</a></td></tr>
81 <tr class="memdesc:a4e7524434525267e29f493a25dcca6b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of the input buffer (don't set manually). <a href="#a4e7524434525267e29f493a25dcca6b5">More...</a><br /></td></tr>
82 <tr class="separator:a4e7524434525267e29f493a25dcca6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:addd36ac8e5e42241c0a57453633970db"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#addd36ac8e5e42241c0a57453633970db">pos</a></td></tr>
84 <tr class="memdesc:addd36ac8e5e42241c0a57453633970db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current buffer position (don't set manually). <a href="#addd36ac8e5e42241c0a57453633970db">More...</a><br /></td></tr>
85 <tr class="separator:addd36ac8e5e42241c0a57453633970db"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a68556d4260153f58dde44e4c365edce6"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a68556d4260153f58dde44e4c365edce6">tmp</a></td></tr>
87 <tr class="memdesc:a68556d4260153f58dde44e4c365edce6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal temporary buffer (don't set manually). <a href="#a68556d4260153f58dde44e4c365edce6">More...</a><br /></td></tr>
88 <tr class="separator:a68556d4260153f58dde44e4c365edce6"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:a8a81853d5903bee2f4e1fa53fdffae6e"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a8a81853d5903bee2f4e1fa53fdffae6e">tmplen</a></td></tr>
90 <tr class="memdesc:a8a81853d5903bee2f4e1fa53fdffae6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal temporary buffer length (don't set manually). <a href="#a8a81853d5903bee2f4e1fa53fdffae6e">More...</a><br /></td></tr>
91 <tr class="separator:a8a81853d5903bee2f4e1fa53fdffae6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:a5af10131ea9f679b4ee174499f92e210"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a5af10131ea9f679b4ee174499f92e210">tmpcap</a></td></tr>
93 <tr class="memdesc:a5af10131ea9f679b4ee174499f92e210"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal temporary buffer capacity (don't set manually). <a href="#a5af10131ea9f679b4ee174499f92e210">More...</a><br /></td></tr>
94 <tr class="separator:a5af10131ea9f679b4ee174499f92e210"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:a34f71a6ab6dcb6892e3b4eb802e75bff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a34f71a6ab6dcb6892e3b4eb802e75bff">error</a></td></tr>
96 <tr class="memdesc:a34f71a6ab6dcb6892e3b4eb802e75bff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parser error code. <a href="#a34f71a6ab6dcb6892e3b4eb802e75bff">More...</a><br /></td></tr>
97 <tr class="separator:a34f71a6ab6dcb6892e3b4eb802e75bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:af6adb3f69616cf9d2bb5ea7b4d837ca5"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#af6adb3f69616cf9d2bb5ea7b4d837ca5">delimiter</a></td></tr>
99 <tr class="memdesc:af6adb3f69616cf9d2bb5ea7b4d837ca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The delimiter that shall be used. <a href="#af6adb3f69616cf9d2bb5ea7b4d837ca5">More...</a><br /></td></tr>
100 <tr class="separator:af6adb3f69616cf9d2bb5ea7b4d837ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <tr class="memitem:afaa2e6a289fa6949b7b01df35fa5def8"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#afaa2e6a289fa6949b7b01df35fa5def8">comment1</a></td></tr>
102 <tr class="memdesc:afaa2e6a289fa6949b7b01df35fa5def8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The first comment character. <a href="#afaa2e6a289fa6949b7b01df35fa5def8">More...</a><br /></td></tr>
103 <tr class="separator:afaa2e6a289fa6949b7b01df35fa5def8"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <tr class="memitem:a9ea7ecb414ca8bc7bef62cdd19cc6363"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a9ea7ecb414ca8bc7bef62cdd19cc6363">comment2</a></td></tr>
105 <tr class="memdesc:a9ea7ecb414ca8bc7bef62cdd19cc6363"><td class="mdescLeft">&#160;</td><td class="mdescRight">The second comment character. <a href="#a9ea7ecb414ca8bc7bef62cdd19cc6363">More...</a><br /></td></tr>
106 <tr class="separator:a9ea7ecb414ca8bc7bef62cdd19cc6363"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <tr class="memitem:a5f3e561e32bac03e36a191a6940cca92"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUcxProperties.html#a5f3e561e32bac03e36a191a6940cca92">comment3</a></td></tr>
108 <tr class="memdesc:a5f3e561e32bac03e36a191a6940cca92"><td class="mdescLeft">&#160;</td><td class="mdescRight">The third comment character. <a href="#a5f3e561e32bac03e36a191a6940cca92">More...</a><br /></td></tr>
109 <tr class="separator:a5f3e561e32bac03e36a191a6940cca92"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 </table>
111 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
112 <div class="textblock"><p><a class="el" href="structUcxProperties.html" title="UcxProperties object for parsing properties data. ">UcxProperties</a> object for parsing properties data. </p>
113 <p>Most of the fields are for internal use only. You may configure the properties parser, e.g. by changing the used delimiter or specifying up to three different characters that shall introduce comments. </p>
114 </div><h2 class="groupheader">Field Documentation</h2>
115 <a id="a6bb4d29686df41a0f42641ee15232bfd"></a>
116 <h2 class="memtitle"><span class="permalink"><a href="#a6bb4d29686df41a0f42641ee15232bfd">&#9670;&nbsp;</a></span>buffer</h2>
117
118 <div class="memitem">
119 <div class="memproto">
120 <table class="memname">
121 <tr>
122 <td class="memname">char* UcxProperties::buffer</td>
123 </tr>
124 </table>
125 </div><div class="memdoc">
126
127 <p>Input buffer (don't set manually). </p>
128 <p>Automatically set by calls to <a class="el" href="properties_8h.html#aaf8de121764a4d22c763ff2ab41f3a4d" title="Sets the input buffer for the properties parser. ">ucx_properties_fill()</a>. </p>
129
130 </div>
131 </div>
132 <a id="a4e7524434525267e29f493a25dcca6b5"></a>
133 <h2 class="memtitle"><span class="permalink"><a href="#a4e7524434525267e29f493a25dcca6b5">&#9670;&nbsp;</a></span>buflen</h2>
134
135 <div class="memitem">
136 <div class="memproto">
137 <table class="memname">
138 <tr>
139 <td class="memname">size_t UcxProperties::buflen</td>
140 </tr>
141 </table>
142 </div><div class="memdoc">
143
144 <p>Length of the input buffer (don't set manually). </p>
145 <p>Automatically set by calls to <a class="el" href="properties_8h.html#aaf8de121764a4d22c763ff2ab41f3a4d" title="Sets the input buffer for the properties parser. ">ucx_properties_fill()</a>. </p>
146
147 </div>
148 </div>
149 <a id="afaa2e6a289fa6949b7b01df35fa5def8"></a>
150 <h2 class="memtitle"><span class="permalink"><a href="#afaa2e6a289fa6949b7b01df35fa5def8">&#9670;&nbsp;</a></span>comment1</h2>
151
152 <div class="memitem">
153 <div class="memproto">
154 <table class="memname">
155 <tr>
156 <td class="memname">char UcxProperties::comment1</td>
157 </tr>
158 </table>
159 </div><div class="memdoc">
160
161 <p>The first comment character. </p>
162 <p>This is '#' by default. </p>
163
164 </div>
165 </div>
166 <a id="a9ea7ecb414ca8bc7bef62cdd19cc6363"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#a9ea7ecb414ca8bc7bef62cdd19cc6363">&#9670;&nbsp;</a></span>comment2</h2>
168
169 <div class="memitem">
170 <div class="memproto">
171 <table class="memname">
172 <tr>
173 <td class="memname">char UcxProperties::comment2</td>
174 </tr>
175 </table>
176 </div><div class="memdoc">
177
178 <p>The second comment character. </p>
179 <p>This is not set by default. </p>
180
181 </div>
182 </div>
183 <a id="a5f3e561e32bac03e36a191a6940cca92"></a>
184 <h2 class="memtitle"><span class="permalink"><a href="#a5f3e561e32bac03e36a191a6940cca92">&#9670;&nbsp;</a></span>comment3</h2>
185
186 <div class="memitem">
187 <div class="memproto">
188 <table class="memname">
189 <tr>
190 <td class="memname">char UcxProperties::comment3</td>
191 </tr>
192 </table>
193 </div><div class="memdoc">
194
195 <p>The third comment character. </p>
196 <p>This is not set by default. </p>
197
198 </div>
199 </div>
200 <a id="af6adb3f69616cf9d2bb5ea7b4d837ca5"></a>
201 <h2 class="memtitle"><span class="permalink"><a href="#af6adb3f69616cf9d2bb5ea7b4d837ca5">&#9670;&nbsp;</a></span>delimiter</h2>
202
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
206 <tr>
207 <td class="memname">char UcxProperties::delimiter</td>
208 </tr>
209 </table>
210 </div><div class="memdoc">
211
212 <p>The delimiter that shall be used. </p>
213 <p>This is '=' by default. </p>
214
215 </div>
216 </div>
217 <a id="a34f71a6ab6dcb6892e3b4eb802e75bff"></a>
218 <h2 class="memtitle"><span class="permalink"><a href="#a34f71a6ab6dcb6892e3b4eb802e75bff">&#9670;&nbsp;</a></span>error</h2>
219
220 <div class="memitem">
221 <div class="memproto">
222 <table class="memname">
223 <tr>
224 <td class="memname">int UcxProperties::error</td>
225 </tr>
226 </table>
227 </div><div class="memdoc">
228
229 <p>Parser error code. </p>
230 <p>This is always 0 on success and a nonzero value on syntax errors. The value is set by <a class="el" href="properties_8h.html#a7e03bc573d45d48c538cd721e810d33c" title="Retrieves the next key/value-pair. ">ucx_properties_next()</a>. </p>
231
232 </div>
233 </div>
234 <a id="addd36ac8e5e42241c0a57453633970db"></a>
235 <h2 class="memtitle"><span class="permalink"><a href="#addd36ac8e5e42241c0a57453633970db">&#9670;&nbsp;</a></span>pos</h2>
236
237 <div class="memitem">
238 <div class="memproto">
239 <table class="memname">
240 <tr>
241 <td class="memname">size_t UcxProperties::pos</td>
242 </tr>
243 </table>
244 </div><div class="memdoc">
245
246 <p>Current buffer position (don't set manually). </p>
247 <p>Used by <a class="el" href="properties_8h.html#a7e03bc573d45d48c538cd721e810d33c" title="Retrieves the next key/value-pair. ">ucx_properties_next()</a>. </p>
248
249 </div>
250 </div>
251 <a id="a68556d4260153f58dde44e4c365edce6"></a>
252 <h2 class="memtitle"><span class="permalink"><a href="#a68556d4260153f58dde44e4c365edce6">&#9670;&nbsp;</a></span>tmp</h2>
253
254 <div class="memitem">
255 <div class="memproto">
256 <table class="memname">
257 <tr>
258 <td class="memname">char* UcxProperties::tmp</td>
259 </tr>
260 </table>
261 </div><div class="memdoc">
262
263 <p>Internal temporary buffer (don't set manually). </p>
264 <p>Used by <a class="el" href="properties_8h.html#a7e03bc573d45d48c538cd721e810d33c" title="Retrieves the next key/value-pair. ">ucx_properties_next()</a>. </p>
265
266 </div>
267 </div>
268 <a id="a5af10131ea9f679b4ee174499f92e210"></a>
269 <h2 class="memtitle"><span class="permalink"><a href="#a5af10131ea9f679b4ee174499f92e210">&#9670;&nbsp;</a></span>tmpcap</h2>
270
271 <div class="memitem">
272 <div class="memproto">
273 <table class="memname">
274 <tr>
275 <td class="memname">size_t UcxProperties::tmpcap</td>
276 </tr>
277 </table>
278 </div><div class="memdoc">
279
280 <p>Internal temporary buffer capacity (don't set manually). </p>
281 <p>Used by <a class="el" href="properties_8h.html#a7e03bc573d45d48c538cd721e810d33c" title="Retrieves the next key/value-pair. ">ucx_properties_next()</a>. </p>
282
283 </div>
284 </div>
285 <a id="a8a81853d5903bee2f4e1fa53fdffae6e"></a>
286 <h2 class="memtitle"><span class="permalink"><a href="#a8a81853d5903bee2f4e1fa53fdffae6e">&#9670;&nbsp;</a></span>tmplen</h2>
287
288 <div class="memitem">
289 <div class="memproto">
290 <table class="memname">
291 <tr>
292 <td class="memname">size_t UcxProperties::tmplen</td>
293 </tr>
294 </table>
295 </div><div class="memdoc">
296
297 <p>Internal temporary buffer length (don't set manually). </p>
298 <p>Used by <a class="el" href="properties_8h.html#a7e03bc573d45d48c538cd721e810d33c" title="Retrieves the next key/value-pair. ">ucx_properties_next()</a>. </p>
299
300 </div>
301 </div>
302 <hr/>The documentation for this struct was generated from the following file:<ul>
303 <li>/home/mike/workspace/c/ucx/src/ucx/<a class="el" href="properties_8h_source.html">properties.h</a></li>
304 </ul>
305 </div><!-- contents -->
306 <!-- start footer part -->
307 <hr class="footer"/><address class="footer"><small>
308 Generated on Thu Dec 19 2019 19:58:24 for ucx by &#160;<a href="http://www.doxygen.org/index.html">
309 <img class="footer" src="doxygen.png" alt="doxygen"/>
310 </a> 1.8.13
311 </small></address>
312 </body>
313 </html>

Mercurial Repository: ucx

mercurial