QCFG_consume.c File Reference

Functions for reading binary configuration files. More...

#include <QCFG_p.h>
#include <QCFG/QCFG.h>
#include <QCFG/QCFG_msgs.h>
#include <RIM/RIM.h>
#include <RIM/RIM_msgs.h>
#include <MSG/MSG_pubdefs.h>

Functions
unsigned	QCFG_consumeMap (RIM_map *map, const char *filename)
	Read map data into the map structure.
unsigned	QCFG_consume (RIM *rim, const char *const *filelist, int nFile)
	Read a configuration into a RIM structure.

---

Detailed Description

Functions for reading binary configuration files.

Author:

James Swain & Owen Saxton

$Id: QCFG_consume.c,v 1.8 2011/03/29 21:47:53 saxton Exp $

---

Function Documentation

unsigned QCFG_consume	(	RIM *	rim,
		const char *const *	filelist,
		int	nFile
	)

Read a configuration into a RIM structure.

The supplied list of binary configuration files is read into the supplied RIM structure.

Parameters:

	rim	Pointer to the RIM to repopulate with the configuration information
	filelist	List of binary configuration files
	nFile	Number of binary configuration files

Return values:

	QCFG_SUCCESS	Success
	QCFG_BADFOPEN	The file could not be opened.
	QCFG_BADVERSN	The file contained a bad version number
	QCFG_BADREAD	An error occured while reading the file

References _QCFG_fileParm::name, QCFG_fioClose(), QCFG_fioOpen(), QCFG_fioReadData(), QCFG_fioReadRecd(), and _QCFG_fileParm::versn.

unsigned QCFG_consumeMap	(	RIM_map *	map,
		const char *	filename
	)

Read map data into the map structure.

Parameters:

	map	Map structure to populate from file
	filename	Name of the binary map file to consume

Return values:

	QCFG_SUCCESS	Success
	QCFG_BADFOPEN	The file could not be opened.
	QCFG_BADVERSN	The file contained a bad version number
	QCFG_BADREAD	An error occured while reading the file

References QCFG_fioClose(), QCFG_fioOpen(), QCFG_fioReadData(), QCFG_fioReadRecd(), and _QCFG_fileParm::versn.