TrustedQSL Library API: cabrillo.h Source File

TrustedQSL Library API

cabrillo.h
Go to the documentation of this file.
1/***************************************************************************
2 cabrillo.h - description
3 -------------------
4 begin : Thu Dec 5 2002
5 copyright : (C) 2002 by ARRL
6 author : Jon Bloom
7 email : jbloom@arrl.org
8 revision : $Id$
9 ***************************************************************************/
10
11#ifndef __CABRILLO_H
12#define __CABRILLO_H
13
14#undef CLIENT_STATIC
15#ifndef LOTW_SERVER
16#define CLIENT_STATIC static
17#else
18#define CLIENT_STATIC
19#endif
20
22
32
33#define TQSL_CABRILLO_MAX_FIELDS 12
34#define TQSL_CABRILLO_FIELD_NAME_LENGTH_MAX 64
35#define TQSL_CABRILLO_FIELD_VALUE_LENGTH_MAX 40
36
38 typedef enum {
39 TQSL_CABRILLO_NO_ERROR,
40 TQSL_CABRILLO_EOF,
41 TQSL_CABRILLO_NO_START_RECORD,
42 TQSL_CABRILLO_NO_CONTEST_RECORD,
43 TQSL_CABRILLO_UNKNOWN_CONTEST,
44 TQSL_CABRILLO_BAD_FIELD_DATA,
45 TQSL_CABRILLO_EOR,
46} TQSL_CABRILLO_ERROR_TYPE;
47
51 typedef enum {
52 TQSL_CABRILLO_HF,
53 TQSL_CABRILLO_VHF,
54 TQSL_CABRILLO_UNKNOWN,
55} TQSL_CABRILLO_FREQ_TYPE;
56
57// Minimum field number for callsign and default field number
58// For VHF, default should be 7.
59#define TQSL_MIN_CABRILLO_MAP_FIELD 5
60#define TQSL_DEF_CABRILLO_MAP_FIELD 8
61
67 typedef struct {
68 char name[TQSL_CABRILLO_FIELD_NAME_LENGTH_MAX +1];
69 char value[TQSL_CABRILLO_FIELD_VALUE_LENGTH_MAX +1];
70} tqsl_cabrilloField;
71
72 typedef void * tQSL_Cabrillo;
73
74#define TQSLLIB_DEF
75#include "tqsllib.h"
76
77#ifdef __cplusplus
78extern "C" {
79#endif
80
82 DLLEXPORT const char* CALLCONVENTION tqsl_cabrilloGetError(TQSL_CABRILLO_ERROR_TYPE err);
83
85 DLLEXPORT int CALLCONVENTION tqsl_beginCabrillo(tQSL_Cabrillo *cabp, const char *filename);
86
88 DLLEXPORT int CALLCONVENTION tqsl_getCabrilloContest(tQSL_Cabrillo cab, char *buf, int bufsiz);
89
91 DLLEXPORT int CALLCONVENTION tqsl_getCabrilloFreqType(tQSL_Cabrillo cab, TQSL_CABRILLO_FREQ_TYPE *type);
92
94 DLLEXPORT int CALLCONVENTION tqsl_getCabrilloLine(tQSL_Cabrillo cab, int *lineno);
95
97 DLLEXPORT const char* CALLCONVENTION tqsl_getCabrilloRecordText(tQSL_Cabrillo cab);
98
107 DLLEXPORT int CALLCONVENTION tqsl_getCabrilloField(tQSL_Cabrillo cab, tqsl_cabrilloField *field, TQSL_CABRILLO_ERROR_TYPE *err);
108
110 DLLEXPORT int CALLCONVENTION tqsl_endCabrillo(tQSL_Cabrillo *cabp);
111
112#ifdef __cplusplus
113}
114#endif
115
117
118#endif // __CABRILLO_H
tqsl_getCabrilloLine
DLLEXPORT int CALLCONVENTION tqsl_getCabrilloLine(tQSL_Cabrillo cab, int *lineno)
tqsl_cabrilloGetError
DLLEXPORT const char *CALLCONVENTION tqsl_cabrilloGetError(TQSL_CABRILLO_ERROR_TYPE err)
TQSL_CABRILLO_ERROR_TYPE
TQSL_CABRILLO_ERROR_TYPE
Cabrillo status values.
Definition cabrillo.h:38
TQSL_CABRILLO_FIELD_VALUE_LENGTH_MAX
#define TQSL_CABRILLO_FIELD_VALUE_LENGTH_MAX
Max field value length.
Definition cabrillo.h:35
tqsl_beginCabrillo
DLLEXPORT int CALLCONVENTION tqsl_beginCabrillo(tQSL_Cabrillo *cabp, const char *filename)
TQSL_CABRILLO_FREQ_TYPE
TQSL_CABRILLO_FREQ_TYPE
Definition cabrillo.h:51
tqsl_endCabrillo
DLLEXPORT int CALLCONVENTION tqsl_endCabrillo(tQSL_Cabrillo *cabp)
tqsl_getCabrilloFreqType
DLLEXPORT int CALLCONVENTION tqsl_getCabrilloFreqType(tQSL_Cabrillo cab, TQSL_CABRILLO_FREQ_TYPE *type)
tqsl_getCabrilloContest
DLLEXPORT int CALLCONVENTION tqsl_getCabrilloContest(tQSL_Cabrillo cab, char *buf, int bufsiz)
TQSL_CABRILLO_FIELD_NAME_LENGTH_MAX
#define TQSL_CABRILLO_FIELD_NAME_LENGTH_MAX
Max field name length.
Definition cabrillo.h:34
tQSL_Cabrillo
void * tQSL_Cabrillo
Opaque cabrillo log type.
Definition cabrillo.h:72
tqsl_getCabrilloRecordText
DLLEXPORT const char *CALLCONVENTION tqsl_getCabrilloRecordText(tQSL_Cabrillo cab)
tqsl_getCabrilloField
DLLEXPORT int CALLCONVENTION tqsl_getCabrilloField(tQSL_Cabrillo cab, tqsl_cabrilloField *field, TQSL_CABRILLO_ERROR_TYPE *err)
tqsl_cabrilloField
Definition cabrillo.h:67
tqsl_cabrilloField::name
char name[TQSL_CABRILLO_FIELD_NAME_LENGTH_MAX+1]
< Cabrillo field
Definition cabrillo.h:68
tqsl_cabrilloField::value
char value[TQSL_CABRILLO_FIELD_VALUE_LENGTH_MAX+1]
Field value.
Definition cabrillo.h:69
tqsllib.h
CALLCONVENTION
#define CALLCONVENTION
Symbol exports - Windows only.
Definition tqsllib.h:27
DLLEXPORT
#define DLLEXPORT
Symbol exports - Windows only.
Definition tqsllib.h:25