Main Page   Modules   Compound List   File List   File Members  

Cabrillo API


Compounds

struct  tqsl_cabrilloField

Defines

#define TQSL_CABRILLO_FIELD_NAME_LENGTH_MAX   64
#define TQSL_CABRILLO_FIELD_VALUE_LENGTH_MAX   40
#define TQSL_MIN_CABRILLO_MAP_FIELD   5

Typedefs

typedef void* tQSL_Cabrillo

Enumerations

enum  TQSL_CABRILLO_ERROR_TYPE {
  TQSL_CABRILLO_NO_ERROR, TQSL_CABRILLO_EOF, TQSL_CABRILLO_NO_START_RECORD, TQSL_CABRILLO_NO_CONTEST_RECORD,
  TQSL_CABRILLO_UNKNOWN_CONTEST, TQSL_CABRILLO_BAD_FIELD_DATA, TQSL_CABRILLO_EOR
}
 Cabrillo status values.

enum  TQSL_CABRILLO_FREQ_TYPE { TQSL_CABRILLO_HF, TQSL_CABRILLO_VHF }

Functions

const char* tqsl_cabrilloGetError (TQSL_CABRILLO_ERROR_TYPE err)
int tqsl_beginCabrillo (tQSL_Cabrillo *cabp, const char *filename)
int tqsl_getCabrilloContest (tQSL_Cabrillo cab, char *buf, int bufsiz)
int tqsl_getCabrilloFreqType (tQSL_Cabrillo cab, TQSL_CABRILLO_FREQ_TYPE *type)
int tqsl_getCabrilloLine (tQSL_Cabrillo cab, int *lineno)
const char* tqsl_getCabrilloRecordText (tQSL_Cabrillo cab)
int tqsl_getCabrilloField (tQSL_Cabrillo cab, tqsl_cabrilloField *field, TQSL_CABRILLO_ERROR_TYPE *err)
int tqsl_endCabrillo (tQSL_Cabrillo *cabp)

Detailed Description

These functions and data structures provide a means of parsing a Cabrillo file into its component fields.

For convenience, the returned fields are identified using field names from the ADIF specification.


Function Documentation

int tqsl_beginCabrillo ( tQSL_Cabrillo * cabp,
const char * filename )
 

Initialize a Cabrillo file for reading

const char * tqsl_cabrilloGetError ( TQSL_CABRILLO_ERROR_TYPE err )
 

Get the Cabrillo error message that corresponds to a particular error value

int tqsl_endCabrillo ( tQSL_Cabrillo * cabp )
 

Finish reading a Cabrillo file and release its resources

int tqsl_getCabrilloContest ( tQSL_Cabrillo cab,
char * buf,
int bufsiz )
 

Get the Contest name as specified in the Cabrillo CONTEST line

int tqsl_getCabrilloField ( tQSL_Cabrillo cab,
tqsl_cabrilloField * field,
TQSL_CABRILLO_ERROR_TYPE * err )
 

Get the next field of the Cabrillo record

err is set to TQSL_CABRILLO_NO_ERROR or TQSL_CABRILLO_EOR (end-of-record) if field was populated with data. If err == TQSL_CABRILLO_EOR, this is the last field of the record.

err == TQSL_CABRILLO_EOF when there is no more data available.

int tqsl_getCabrilloFreqType ( tQSL_Cabrillo cab,
TQSL_CABRILLO_FREQ_TYPE * type )
 

Get the Frequency type (HF or VHF) as determined by the contest

int tqsl_getCabrilloLine ( tQSL_Cabrillo cab,
int * lineno )
 

Get the current line number (starting from 1) of the input file

const char * tqsl_getCabrilloRecordText ( tQSL_Cabrillo cab )
 

Get the text of the current Cabrillo record


Generated at Sun Oct 12 10:02:48 2003 for TrustedQSL Library API by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001