db_vrf.h File Reference

#include <mix/ErrCodes.h>
#include <mix/Types.h>
#include <ldb/dbtc.h>

Go to the source code of this file.

Classes
struct	dbDomainVRF

Macros
#define	dbVRF_Label   (1<<0)
#define	dbVRF_Width   (1<<1)
#define	dbVRF_Prec   (1<<2)
#define	dbVRF_Tail   (1<<3)

Functions
ErrCode	dbLoadSystemVRF (const char *szTableType, int *nDmns, STRLIST *pOrder, dbDomainVRF **pVRFs)
ErrCode	dbLoadDomainVRF (const char *szPathVRF, const char *szTableType, int *nDmns, STRLIST *pOrder, dbDomainVRF **pVRFs)
ErrCode	dbSaveDomainVRF (const char *szPathVRF, const char *szTableType, int nDmns, const dbDomainVRF *pVRFs)
void	dbFreeDomainVRF (int nDmns, STRLIST pOrder, dbDomainVRF *pVRFs)
int	dbComposedLenVRF (dbHandle db, int nDmns, const dbDomainVRF *pVRFs)
void	dbComposeTitleVRF (dbHandle db, char *szTitle, int nDmns, const dbDomainVRF *pVRFs)
void	dbComposeLineVRF (dbHandle db, int iLineNo, char *szLine, int nDmns, const dbDomainVRF *pVRFs)

Detailed Description

Visual representation format is provided for data base table. It allows to support custom order, width, format and label of data base table columns in text representation.

Function Documentation

int dbComposedLenVRF	(	dbHandle	db,
		int	nDmns,
		const dbDomainVRF *	pVRFs
	)

Computes length of line which may contain title and any line with values of opened data base with handle db. Order and output specifics is provided by VRF structure.

void dbComposeLineVRF	(	dbHandle	db,
		int	iLineNo,
		char *	szLine,
		int	nDmns,
		const dbDomainVRF *	pVRFs
	)

Print line of values in szLine for line with number iLineNo of opened data base with handle db. Order and output specifics is provided by VRF structure.

void dbComposeTitleVRF	(	dbHandle	db,
		char *	szTitle,
		int	nDmns,
		const dbDomainVRF *	pVRFs
	)

Print line of column names in szTitle of opened data base with handle db. Order and output specifics is provided by VRF structure.

void dbFreeDomainVRF	(	int	nDmns,
		STRLIST	pOrder,
		dbDomainVRF *	pVRFs
	)

Release memory under given number of VRFs, allocated by dbLoadDomainVRF() and dbLoadSystemVRF(). pVRFs itself is released too.

ErrCode dbLoadDomainVRF	(	const char *	szPathVRF,
		const char *	szTableType,
		int *	nDmns,
		STRLIST *	pOrder,
		dbDomainVRF **	pVRFs
	)

Load VRF domain descriptors for given table type from given file. Number of domains is equal to defined in VRF, not in ttdesc.4db. For example, undefined domains may be described. Number of items in pOrder and in pVRFs are equal. Both pOrder and pVRFs are optional and may be NULL.

ErrCode dbLoadSystemVRF	(	const char *	szTableType,
		int *	nDmns,
		STRLIST *	pOrder,
		dbDomainVRF **	pVRFs
	)

Load system default VRF domain descriptors for given table type. Number of domains is equal to defined in VRF, not in ttdesc.4db. For example, undefined domains may be described. Number of items in pOrder and in pVRFs are equal. Both pOrder and pVRFs are optional and may be NULL.

ErrCode dbSaveDomainVRF	(	const char *	szPathVRF,
		const char *	szTableType,
		int	nDmns,
		const dbDomainVRF *	pVRFs
	)

Overwrite VRF domain descriptors for given table type in given file.