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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>TrustedQSL Library API: ADIF API</title>
<link href="tqsllib.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>ADIF API</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structtqsl__adifFieldDefinitions.html">tqsl_adifFieldDefinitions</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structtqsl__adifFieldResults.html">tqsl_adifFieldResults</a></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="ADIF::TQSL_ADIF_FIELD_NAME_LENGTH_MAX" ></a>
#define </td><td class="memItemRight" valign=bottom><b>TQSL_ADIF_FIELD_NAME_LENGTH_MAX</b> 64</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="ADIF::TQSL_ADIF_FIELD_SIZE_LENGTH_MAX" ></a>
#define </td><td class="memItemRight" valign=bottom><b>TQSL_ADIF_FIELD_SIZE_LENGTH_MAX</b> 10</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="ADIF::TQSL_ADIF_FIELD_TYPE_LENGTH_MAX" ></a>
#define </td><td class="memItemRight" valign=bottom><b>TQSL_ADIF_FIELD_TYPE_LENGTH_MAX</b> 1</td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="ADIF::tQSL_ADIF" ></a>
typedef void * </td><td class="memItemRight" valign=bottom><b>tQSL_ADIF</b></td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><b>TQSL_ADIF_BOOLEAN</b> { <b>TQSL_FALSE</b>,
<b>TQSL_TRUE</b>
}</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a11">TQSL_ADIF_RANGE_TYPE</a> { <b>TQSL_ADIF_RANGE_TYPE_NONE</b>,
<b>TQSL_ADIF_RANGE_TYPE_MINMAX</b>,
<b>TQSL_ADIF_RANGE_TYPE_ENUMERATION</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies the type of range limits to apply to a field. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a12">TQSL_ADIF_GET_FIELD_ERROR</a> { <br>
<b>TQSL_ADIF_GET_FIELD_SUCCESS</b>,
<b>TQSL_ADIF_GET_FIELD_NO_NAME_MATCH</b>,
<b>TQSL_ADIF_GET_FIELD_NO_TYPE_MATCH</b>,
<b>TQSL_ADIF_GET_FIELD_NO_RANGE_MATCH</b>,
<br>
<b>TQSL_ADIF_GET_FIELD_NO_ENUMERATION_MATCH</b>,
<b>TQSL_ADIF_GET_FIELD_NO_RESULT_ALLOCATION</b>,
<b>TQSL_ADIF_GET_FIELD_NAME_LENGTH_OVERFLOW</b>,
<b>TQSL_ADIF_GET_FIELD_DATA_LENGTH_OVERFLOW</b>,
<br>
<b>TQSL_ADIF_GET_FIELD_SIZE_OVERFLOW</b>,
<b>TQSL_ADIF_GET_FIELD_TYPE_OVERFLOW</b>,
<b>TQSL_ADIF_GET_FIELD_ERRONEOUS_STATE</b>,
<b>TQSL_ADIF_GET_FIELD_EOF</b>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Response values returned from <a class="el" href="group__ADIF.html#a3">tqsl_getADIFField()</a>. <br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>DLLEXPORT char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a1">tqsl_adifGetError</a> (<a class="el" href="group__ADIF.html#a12">TQSL_ADIF_GET_FIELD_ERROR</a> status)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>DLLEXPORT int </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a2">tqsl_beginADIF</a> (tQSL_ADIF *adifp, const char *filename)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>DLLEXPORT int </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a3">tqsl_getADIFField</a> (tQSL_ADIF adif, <a class="el" href="structtqsl__adifFieldResults.html">tqsl_adifFieldResults</a> *field, <a class="el" href="group__ADIF.html#a12">TQSL_ADIF_GET_FIELD_ERROR</a> *status, const <a class="el" href="structtqsl__adifFieldDefinitions.html">tqsl_adifFieldDefinitions</a> *adifFields, const char *const *typesDefined, unsigned char *(*allocator)(size_t))</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>DLLEXPORT int </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a4">tqsl_getADIFLine</a> (tQSL_ADIF adif, int *lineno)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>DLLEXPORT int </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a5">tqsl_endADIF</a> (tQSL_ADIF *adifp)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>DLLEXPORT int </td><td class="memItemRight" valign=bottom><a class="el" href="group__ADIF.html#a6">tqsl_adifMakeField</a> (const char *fieldname, char type, const unsigned char *value, int len, unsigned char *buf, int buflen)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
These functions and data structures provide a means of parsing an ADIF file into its component fields, along with range-checking the field contents. <hr><h2>Function Documentation</h2>
<a class="anchor" name="a1" doxytag="adif.h::tqsl_adifGetError" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> DLLEXPORT char* tqsl_adifGetError </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__ADIF.html#a12">TQSL_ADIF_GET_FIELD_ERROR</a> </td>
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the ADIF error message that corresponds to a particular error value </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="adif.h::tqsl_adifMakeField" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> DLLEXPORT int tqsl_adifMakeField </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>fieldname</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>char </td>
<td class="mdname" nowrap> <em>type</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const unsigned char * </td>
<td class="mdname" nowrap> <em>value</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>len</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned char * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>buflen</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Form an ADIF field string.<p>
N.B. On systems that distinguish text-mode files from binary-mode files, notably Windows, the text should be written in binary mode. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="adif.h::tqsl_beginADIF" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> DLLEXPORT int tqsl_beginADIF </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_ADIF * </td>
<td class="mdname" nowrap> <em>adifp</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>filename</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initialize an ADIF file for reading </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="adif.h::tqsl_endADIF" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> DLLEXPORT int tqsl_endADIF </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_ADIF * </td>
<td class="mdname1" valign="top" nowrap> <em>adifp</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
End and release an ADIF file </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="adif.h::tqsl_getADIFField" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> DLLEXPORT int tqsl_getADIFField </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_ADIF </td>
<td class="mdname" nowrap> <em>adif</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structtqsl__adifFieldResults.html">tqsl_adifFieldResults</a> * </td>
<td class="mdname" nowrap> <em>field</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__ADIF.html#a12">TQSL_ADIF_GET_FIELD_ERROR</a> * </td>
<td class="mdname" nowrap> <em>status</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="structtqsl__adifFieldDefinitions.html">tqsl_adifFieldDefinitions</a> * </td>
<td class="mdname" nowrap> <em>adifFields</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char *const * </td>
<td class="mdname" nowrap> <em>typesDefined</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned char *(* </td>
<td class="mdname" nowrap> <em>allocator</em>)(size_t)</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the next field from an ADIF file<p>
<ul>
<li><code>adif</code> - ADIF handle returned from <a class="el" href="group__ADIF.html#a2">tqsl_beginADIF()</a> </li>
<li><code>field</code> - pointer to struct that contains the field data and description </li>
<li><code>status</code> - pointer to returned status variable </li>
<li><code>adifFields</code> - pointer to an array of field-definition structures. The last item in the array should have an empty string as its <code>name</code> member. </li>
<li><code>typesDefined</code> - pointer to an array of char pointers that define the allowed field-type strings. The last item in the array should point to an empty string. </li>
<li><code>allocator</code> - pointer to a function that returns a pointer to a memory block of the specified size. This function will be called at most one time during a call to tqsl_getADIFField. The returned pointer will then be used to populate the <code>data</code> member of <code>field</code>. The caller is responsible for freeing this memory, if needed. </li>
</ul>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="adif.h::tqsl_getADIFLine" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> DLLEXPORT int tqsl_getADIFLine </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_ADIF </td>
<td class="mdname" nowrap> <em>adif</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>lineno</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the current line number (starting from 1) of the input file </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Feb 22 08:15:36 2005 for TrustedQSL Library API by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.4 </small></address>
</body>
</html>
|
