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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
<!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: Converter 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>Converter API</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></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="Convert::tQSL_Converter" ></a>
typedef void * </td><td class="memItemRight" valign=bottom><b>tQSL_Converter</b></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a1">tqsl_beginADIFConverter</a> (tQSL_Converter *conv, const char *filename, tQSL_Cert *certs, int ncerts, tQSL_Location loc)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a2">tqsl_beginCabrilloConverter</a> (tQSL_Converter *conv, const char *filename, tQSL_Cert *certs, int ncerts, tQSL_Location loc)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a3">tqsl_endConverter</a> (tQSL_Converter *conv)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a4">tqsl_setConverterAllowBadCall</a> (tQSL_Converter conv, int allow)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a5">tqsl_setADIFConverterDateFilter</a> (tQSL_Converter conv, <a class="el" href="structtQSL__Date.html">tQSL_Date</a> *start, <a class="el" href="structtQSL__Date.html">tQSL_Date</a> *end)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a6">tqsl_getConverterGABBI</a> (tQSL_Converter conv)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a7">tqsl_getConverterCert</a> (tQSL_Converter conv, tQSL_Cert *certp)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a8">tqsl_getConverterLine</a> (tQSL_Converter conv, int *lineno)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="group__Convert.html#a9">tqsl_getConverterRecordText</a> (tQSL_Converter conv)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The Converter API provides the capability of converting Cabrillo and ADIF files to GABBI output. <hr><h2>Function Documentation</h2>
<a class="anchor" name="a1" doxytag="tqslconvert.h::tqsl_beginADIFConverter" ></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"> int tqsl_beginADIFConverter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter * </td>
<td class="mdname" nowrap> <em>conv</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></td>
<td class="md" nowrap>tQSL_Cert * </td>
<td class="mdname" nowrap> <em>certs</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>ncerts</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>tQSL_Location </td>
<td class="mdname" nowrap> <em>loc</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>
Initiates the conversion process for an ADIF file.<p>
<code>certs</code> and <code>ncerts</code> define a set of certificates that are available to the converter for signing records. Typically, this list will be obtained by calling <a class="el" href="group__CertStuff.html#a0">tqsl_selectCertificates()</a>.<p>
<a class="el" href="group__Convert.html#a3">tqsl_endConverter()</a> should be called to free the resources when the conversion is finished. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="tqslconvert.h::tqsl_beginCabrilloConverter" ></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"> int tqsl_beginCabrilloConverter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter * </td>
<td class="mdname" nowrap> <em>conv</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></td>
<td class="md" nowrap>tQSL_Cert * </td>
<td class="mdname" nowrap> <em>certs</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>ncerts</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>tQSL_Location </td>
<td class="mdname" nowrap> <em>loc</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>
Initiates the conversion process for a Cabrillo file.<p>
<code>certs</code> and <code>ncerts</code> define a set of certificates that are available to the converter for signing records. Typically, this list will be obtained by calling <a class="el" href="group__CertStuff.html#a0">tqsl_selectCertificates()</a>.<p>
<a class="el" href="group__Convert.html#a3">tqsl_endConverter()</a> should be called to free the resources when the conversion is finished. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="tqslconvert.h::tqsl_endConverter" ></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"> int tqsl_endConverter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter * </td>
<td class="mdname1" valign="top" nowrap> <em>conv</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 the conversion process by freeing the used resources. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="tqslconvert.h::tqsl_getConverterCert" ></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"> int tqsl_getConverterCert </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter </td>
<td class="mdname" nowrap> <em>conv</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>tQSL_Cert * </td>
<td class="mdname" nowrap> <em>certp</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 certificate used to sign the most recent QSO record. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="tqslconvert.h::tqsl_getConverterGABBI" ></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"> const char* tqsl_getConverterGABBI </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter </td>
<td class="mdname1" valign="top" nowrap> <em>conv</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>
This is the main converter function. It returns a single GABBI record.<p>
Returns the NULL pointer on error or EOF. (Test tQSL_Error to determine which.)<p>
tQSL_Error is set to TQSL_DATE_OUT_OF_RANGE if QSO date range checking is active (see ::tqsl_useADIFConverterDateFilter) and the QSO date is outside the specified range. This is a non-fatal error.<p>
N.B. On systems that distinguish text-mode files from binary-mode files, notably Windows, the GABBI records should be written in binary mode.<p>
N.B. If the selected certificate has not been initialized for signing via <a class="el" href="group__Sign.html#a0">tqsl_beginSigning()</a>, this function will return a TQSL_SIGNINIT_ERROR. The cert that caused the error can be obtained via <a class="el" href="group__Convert.html#a7">tqsl_getConverterCert()</a>, initialized for signing, and then this function can be called again. No data records will be lost in this process. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="tqslconvert.h::tqsl_getConverterLine" ></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"> int tqsl_getConverterLine </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter </td>
<td class="mdname" nowrap> <em>conv</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 input-file line number last read by the converter, starting at line 1. </td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="tqslconvert.h::tqsl_getConverterRecordText" ></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"> const char* tqsl_getConverterRecordText </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter </td>
<td class="mdname1" valign="top" nowrap> <em>conv</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 text of the last record read by the converter.<p>
Returns NULL on error. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="tqslconvert.h::tqsl_setADIFConverterDateFilter" ></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"> int tqsl_setADIFConverterDateFilter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter </td>
<td class="mdname" nowrap> <em>conv</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structtQSL__Date.html">tQSL_Date</a> * </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structtQSL__Date.html">tQSL_Date</a> * </td>
<td class="mdname" nowrap> <em>end</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>
Set QSO date filtering in the converter.<p>
If <code>start</code> points to a valid date, QSOs prior to that date will be ignored by the converter. Similarly, if <code>end</code> points to a valid date, QSOs after that date will be ignored. Either or both may be NULL (or point to an invalid date) to disable date filtering for the respective range. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="tqslconvert.h::tqsl_setConverterAllowBadCall" ></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"> int tqsl_setConverterAllowBadCall </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">tQSL_Converter </td>
<td class="mdname" nowrap> <em>conv</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>allow</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>
Configure the converter to allow (allow != 0) or disallow (allow == 0) nonamateur call signs in the CALL field. (Note: the test for validity is fairly trivial and will allow some nonamateur calls to get through, but it does catch most common errors.)<p>
<code>allow</code> defaults to 0 when tqsl_beginADIFConverter or tqsl_beginCabrilloConverter is called. </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>
|
