linux.techass.com
"Tell Bill where to go today!"

Home/What's New
Products
Projects

Technology Associates Homepage


eternaLight!
Alien Technology?



[an error occurred while processing this directive]

Powered by Linux!
(of course)

SourceForge Logo xdb Documentation
Main Page   Class Hierarchy   Compound List   Header Files   Compound Members  

xbDatabase Class Reference

xbDatabase class. More...

#include <database.h>

List of all members.


Public Members

 xbDatabase (xbXBase *xbase)
Short description. More...

 ~xbDatabase ()
Short description.

xbShort LastError (void)
xbXBaseGetXBase (void)
xbDbfGetDatabaseDbf (void)
xbDbfGetTableDbf (void)
xbDbfGetFieldDbf (void)
xbDbfGetIndexDbf (void)
xbDbfGetReportDbf (void)
xbNdxGetTableIndex (xbShort indexNum)
xbNdxGetFieldIndex (xbShort indexNum)
xbNdxGetIndexIndex (xbShort indexNum)
xbNdxGetReportIndex (xbShort indexNum)
xbShort Open (const char *path)
Short description. More...

xbShort Create (const char *path, xbShort overlay = XB_DONTOVERLAY)
Short description. More...

void Close (void)
Short description.

const char* GetPath (void)
xbShort GetDatabaseName (char *val)
Short description. More...

xbShort GetDatabaseDesc (char *val)
Short description. More...

xbShort GetDatabaseCompany (char *val)
Short description. More...

xbShort GetDatabaseVersion (char *val)
Short description. More...

xbShort GetDatabaseCreateDate (char *val)
Short description. More...

xbShort GetDatabaseModDate (char *val)
Short description. More...

xbShort GetDatabaseXDBVersion (char *val)
Short description. More...

xbShort SetDatabaseName (const char *val)
Short description. More...

xbShort SetDatabaseDesc (const char *dval)
Short description. More...

xbShort SetDatabaseCompany (const char *val)
Short description. More...

xbShort SetDatabaseVersion (const char *val)
Short description. More...

xbShort SetDatabaseCreateDate (const char *val)
Short description. More...

xbShort SetDatabaseModDate (const char *val)
Short description. More...

xbShort SetDatabaseXDBVersion (const char *val)
Short description. More...

xbShort GetNumTables (void)
Short description.

xbShort GetTableId (xbShort tableNum, char *tableId)
Short description. More...

xbShort GetTableFileName (const char *tableId, char *tableName)
Short description. More...

xbShort GetTableDesc (const char *tableId, char *desc)
Short description. More...

xbShort GetTableRealDelete (const char *tableId, bool *realDelete)
Short description. More...

xbShort GetTableVersion (const char *tableId, xbShort *version)
Short description. More...

xbShort AddTable (const char *tableId, const char *tableName, const char *desc, xbShort version = 3, bool realDelete = 0)
Short description. More...

xbShort RemoveTable (const char *tableId)
Short description. More...

xbShort ChangeTable (const char *tableId, const char *tableName, const char *desc, xbShort version = 3, bool realDelete = 0)
Short description. More...

bool TableExists (const char *tableId)
Short description. More...

void RemoveTableFiles (const char *tableId)
Short description. More...

xbShort GetNumFields (const char *tableId)
Short description. More...

xbShort LookupField (const char *tableId, const char *fieldName)
Short description. More...

xbShort LookupField (const char *tableId, xbShort fieldNum)
Short description. More...

xbShort GetFieldNum (const char *tableId, const char *fieldName, xbShort *fieldNum)
Short description. More...

xbShort GetFieldType (const char *tableId, const char *fieldName, char *type)
Short description. More...

xbShort GetFieldDesc (const char *tableId, const char *fieldName, char *desc)
Short description. More...

xbShort GetFieldPrompt (const char *tableId, const char *fieldName, char *prompt)
Short description. More...

xbShort GetFieldInputSpec (const char *tableId, const char *fieldName, char *inputSpec)
Short description. More...

xbShort GetFieldMinValue (const char *tableId, const char *fieldName, char *minValue)
Short description. More...

xbShort GetFieldMaxValue (const char *tableId, const char *fieldName, char *maxValue)
Short description. More...

xbShort GetFieldLength (const char *tableId, const char *fieldName, xbShort *length)
Short description. More...

xbShort GetFieldDecimals (const char *tableId, const char *fieldName, xbShort *decimals)
Short description. More...

xbShort GetFieldName (const char *tableId, xbShort fieldNum, char *fieldName)
Short description. More...

xbShort GetFieldType (const char *tableId, xbShort fieldNum, char *type)
Short description. More...

xbShort GetFieldDesc (const char *tableId, xbShort fieldNum, char *desc)
Short description. More...

xbShort GetFieldPrompt (const char *tableId, xbShort fieldNum, char *prompt)
Short description. More...

xbShort GetFieldInputSpec (const char *tableId, xbShort fieldNum, char *inputSpec)
Short description. More...

xbShort GetFieldMinValue (const char *tableId, xbShort fieldNum, char *minValue)
Short description. More...

xbShort GetFieldMaxValue (const char *tableId, xbShort fieldNum, char *maxValue)
Short description. More...

xbShort GetFieldLength (const char *tableId, xbShort fieldNum, xbShort *length)
Short description. More...

xbShort GetFieldDecimals (const char *tableId, xbShort fieldNum, xbShort *decimals)
Short description. More...

xbShort AddField (const char *tableId, xbShort fieldNum, const char *fieldName, const char type, const char *desc, const char *prompt, const char *inputSpec, const char *minValue, const char *maxValue, xbShort length, xbShort decimals)
Short description. More...

xbShort RemoveField (const char *tableId, const char *fieldName)
Short description. More...

xbShort RemoveField (const char *tableId, xbShort fieldNum)
Short description. More...

xbShort ChangeField (const char *tableId, xbShort fieldNum, const char *fieldName, const char type, const char *desc, const char *prompt, const char *inputSpec, const char *minValue, const char *maxValue, xbShort length, xbShort decimals)
Short description. More...

xbShort GetNumIndexes (const char *tableId)
Short description. More...

xbShort LookupIndex (const char *tableId, const char *indexName)
Short description. More...

xbShort LookupIndex (const char *tableId, xbShort indexNum)
Short description. More...

xbShort GetIndexNum (const char *tableId, const char *indexName, xbShort *num)
Short description. More...

xbShort GetIndexUnique (const char *tableId, const char *indexName, bool *unique)
Short description. More...

xbShort GetIndexExpression (const char *tableId, const char *indexName, char *expression)
Short description. More...

xbShort GetIndexDesc (const char *tableId, const char *indexName, char *desc)
Short description. More...

xbShort GetIndexNodeSize (const char *tableId, const char *indexName, xbShort *nodeSize)
Short description. More...

xbShort GetIndexType (const char *tableId, const char *indexName, char *type)
Short description. More...

xbShort GetIndexName (const char *tableId, xbShort indexNum, char *name)
Short description. More...

xbShort GetIndexUnique (const char *tableId, xbShort indexNum, bool *unique)
Short description. More...

xbShort GetIndexExpression (const char *tableId, xbShort indexNum, char *expression)
Short description. More...

xbShort GetIndexDesc (const char *tableId, xbShort indexNum, char *desc)
Short description. More...

xbShort GetIndexNodeSize (const char *tableId, xbShort indexNum, xbShort *nodeSize)
Short description. More...

xbShort GetIndexType (const char *tableId, xbShort indexNum, char *type)
Short description. More...

xbShort AddIndex (const char *tableId, xbShort indexNum, const char *indexName, bool unique, const char *expression, const char *desc, xbShort nodeSize, const char *type)
Short description. More...

xbShort RemoveIndex (const char *tableId, xbShort indexNum)
Short description. More...

xbShort RemoveIndex (const char *tableId, const char *indexName)
Short description. More...

xbShort ChangeIndex (const char *tableId, xbShort indexNum, const char *indexName, bool unique, const char *expression, const char *desc, xbShort nodeSize, const char *type)
Short description. More...

bool IndexExists (const char *tableId, xbShort indexNum)
Short description. More...

void RemoveIndexFile (const char *tableId, xbShort indexNum)
Short description. More...

xbShort GetNumReports (void)
Short description.

xbShort LookupReport (xbShort reportNum)
Short description. More...

xbShort GetReportTableId (xbShort reportNum, char *tableId)
Short description. More...

xbShort GetReportTitle (xbShort reportNum, char *title)
Short description. More...

xbShort GetReportIndexNum (xbShort reportNum, xbShort *indexNum)
Short description. More...

xbShort GetReportMinKey (xbShort reportNum, char *minKey)
Short description. More...

xbShort GetReportMaxKey (xbShort reportNum, char *maxKey)
Short description. More...

xbShort GetReportQuery (xbShort reportNum, char *query)
Short description. More...

xbShort GetReportFieldList (xbShort reportNum, char *fieldList)
Short description. More...

xbShort GetReportFormat (xbShort reportNum, char *format)
Short description. More...

xbShort AddReport (const char *tableId, xbShort reportNum, const char *title, xbShort indexNum, const char *minKey, const char *maxKey, const char *query, const char *fieldList, const char *format)
Short description. More...

xbShort RemoveReport (xbShort reportNum)
Short description. More...

xbShort ChangeReport (const char *tableId, xbShort reportNum, const char *title, xbShort indexNum, const char *minKey, const char *maxKey, const char *query, const char *fieldList, const char *format)
Short description. More...

xbDbfOpenDbf (const char *tableId)
Short description. More...

xbDbfCreateDbf (const char *tableId, xbShort overlay = XB_DONTOVERLAY)
Short description. More...

xbShort Pack (const char *tableId = 0, void (*packStatusFunc)(xbLong itemNum, xbLong numItems) = 0, void (*indexStatusFunc)(xbLong itemNum, xbLong numItems) = 0)
Short description. More...

xbShort ReIndex (const char *tableId = 0, xbShort indexNum = -1, void (*statusFunc)(xbLong itemNum, xbLong numItems) = 0)
Short description. More...

xbShort Zap (const char *tableId = 0)
Short description. More...


Detailed Description

xbDatabase class.


Member Function Documentation

xbDatabase::xbDatabase (xbXBase * xbase)

Short description.

Parameters:
xbase  

xbShort xbDatabase::Open (const char * path)

Short description.

Parameters:
path  

xbShort xbDatabase::Create (const char * path, xbShort overlay = XB_DONTOVERLAY)

Short description.

Parameters:
path  
overlay  

xbShort xbDatabase::GetDatabaseName (char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::GetDatabaseDesc (char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::GetDatabaseCompany (char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::GetDatabaseVersion (char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::GetDatabaseCreateDate (char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::GetDatabaseModDate (char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::GetDatabaseXDBVersion (char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::SetDatabaseName (const char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::SetDatabaseDesc (const char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::SetDatabaseCompany (const char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::SetDatabaseVersion (const char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::SetDatabaseCreateDate (const char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::SetDatabaseModDate (const char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::SetDatabaseXDBVersion (const char * val)

Short description.

Parameters:
val  

xbShort xbDatabase::GetTableId (xbShort tableNum, char * tableId)

Short description.

Parameters:
tableNum  
tableId  

xbShort xbDatabase::GetTableFileName (const char * tableId, char * tableName)

Short description.

Parameters:
tableId  
tableName  

xbShort xbDatabase::GetTableDesc (const char * tableId, char * desc)

Short description.

Parameters:
tableId  
desc  

xbShort xbDatabase::GetTableRealDelete (const char * tableId, bool * realDelete)

Short description.

Parameters:
tableId  
realDelete  

xbShort xbDatabase::GetTableVersion (const char * tableId, xbShort * version)

Short description.

Parameters:
tableId  
version  

xbShort xbDatabase::AddTable (const char * tableId, const char * tableName, const char * desc, xbShort version = 3, bool realDelete = 0)

Short description.

Parameters:
tableId  
tableName  
desc  
version  
realDelete  

xbShort xbDatabase::RemoveTable (const char * tableId)

Short description.

Parameters:
tableId  

xbShort xbDatabase::ChangeTable (const char * tableId, const char * tableName, const char * desc, xbShort version = 3, bool realDelete = 0)

Short description.

Parameters:
tableId  
tableName  
desc  
version  
realDelete  

bool xbDatabase::TableExists (const char * tableId)

Short description.

Parameters:
tableId  

void xbDatabase::RemoveTableFiles (const char * tableId)

Short description.

Parameters:
tableId  

xbShort xbDatabase::GetNumFields (const char * tableId)

Short description.

Parameters:
tableId  

xbShort xbDatabase::LookupField (const char * tableId, const char * fieldName)

Short description.

Parameters:
tableId  
fieldName  

xbShort xbDatabase::LookupField (const char * tableId, xbShort fieldNum)

Short description.

Parameters:
tableId  
fieldNum  

xbShort xbDatabase::GetFieldNum (const char * tableId, const char * fieldName, xbShort * fieldNum)

Short description.

Parameters:
tableId  
fieldName  
fieldNum  

xbShort xbDatabase::GetFieldType (const char * tableId, const char * fieldName, char * type)

Short description.

Parameters:
tableId  
fieldName  
type  

xbShort xbDatabase::GetFieldDesc (const char * tableId, const char * fieldName, char * desc)

Short description.

Parameters:
tableId  
fieldName  
desc  

xbShort xbDatabase::GetFieldPrompt (const char * tableId, const char * fieldName, char * prompt)

Short description.

Parameters:
tableId  
fieldName  
prompt  

xbShort xbDatabase::GetFieldInputSpec (const char * tableId, const char * fieldName, char * inputSpec)

Short description.

Parameters:
tableId  
fieldName  
inputSpec  

xbShort xbDatabase::GetFieldMinValue (const char * tableId, const char * fieldName, char * minValue)

Short description.

Parameters:
tableId  
fieldName  
minValue  

xbShort xbDatabase::GetFieldMaxValue (const char * tableId, const char * fieldName, char * maxValue)

Short description.

Parameters:
tableId  
fieldName  
maxValue  

xbShort xbDatabase::GetFieldLength (const char * tableId, const char * fieldName, xbShort * length)

Short description.

Parameters:
tableId  
fieldName  
length  

xbShort xbDatabase::GetFieldDecimals (const char * tableId, const char * fieldName, xbShort * decimals)

Short description.

Parameters:
tableId  
fieldName  
decimals  

xbShort xbDatabase::GetFieldName (const char * tableId, xbShort fieldNum, char * fieldName)

Short description.

Parameters:
tableId  
fieldNum  
fieldName  

xbShort xbDatabase::GetFieldType (const char * tableId, xbShort fieldNum, char * type)

Short description.

Parameters:
tableId  
fieldNum  
type  

xbShort xbDatabase::GetFieldDesc (const char * tableId, xbShort fieldNum, char * desc)

Short description.

Parameters:
tableId  
fieldNum  
desc  

xbShort xbDatabase::GetFieldPrompt (const char * tableId, xbShort fieldNum, char * prompt)

Short description.

Parameters:
tableId  
fieldNum  
prompt  

xbShort xbDatabase::GetFieldInputSpec (const char * tableId, xbShort fieldNum, char * inputSpec)

Short description.

Parameters:
tableId  
fieldNum  
inputSpec  

xbShort xbDatabase::GetFieldMinValue (const char * tableId, xbShort fieldNum, char * minValue)

Short description.

Parameters:
tableId  
fieldNum  
minValue  

xbShort xbDatabase::GetFieldMaxValue (const char * tableId, xbShort fieldNum, char * maxValue)

Short description.

Parameters:
tableId  
fieldNum  
maxValue  

xbShort xbDatabase::GetFieldLength (const char * tableId, xbShort fieldNum, xbShort * length)

Short description.

Parameters:
tableId  
fieldNum  
length  

xbShort xbDatabase::GetFieldDecimals (const char * tableId, xbShort fieldNum, xbShort * decimals)

Short description.

Parameters:
tableId  
fieldNum  
decimals  

xbShort xbDatabase::AddField (const char * tableId, xbShort fieldNum, const char * fieldName, const char type, const char * desc, const char * prompt, const char * inputSpec, const char * minValue, const char * maxValue, xbShort length, xbShort decimals)

Short description.

Parameters:
tableId  
fieldNum  
fieldName  
type  
desc  
prompt  
inputSpec  
minValue  
maxValue  
length  
decimals  

xbShort xbDatabase::RemoveField (const char * tableId, const char * fieldName)

Short description.

Parameters:
tableId  
fieldName  

xbShort xbDatabase::RemoveField (const char * tableId, xbShort fieldNum)

Short description.

Parameters:
tableId  
fieldNum  

xbShort xbDatabase::ChangeField (const char * tableId, xbShort fieldNum, const char * fieldName, const char type, const char * desc, const char * prompt, const char * inputSpec, const char * minValue, const char * maxValue, xbShort length, xbShort decimals)

Short description.

Parameters:
tableId  
fieldNum  
fieldName  
type  
desc  
prompt  
inputSpec  
minValue  
maxValue  
length  
decimals  

xbShort xbDatabase::GetNumIndexes (const char * tableId)

Short description.

Parameters:
tableId  

xbShort xbDatabase::LookupIndex (const char * tableId, const char * indexName)

Short description.

Parameters:
tableId  
indexName  

xbShort xbDatabase::LookupIndex (const char * tableId, xbShort indexNum)

Short description.

Parameters:
tableId  
indexNum  

xbShort xbDatabase::GetIndexNum (const char * tableId, const char * indexName, xbShort * num)

Short description.

Parameters:
tableId  
indexName  
num  

xbShort xbDatabase::GetIndexUnique (const char * tableId, const char * indexName, bool * unique)

Short description.

Parameters:
tableId  
indexName  
unique  

xbShort xbDatabase::GetIndexExpression (const char * tableId, const char * indexName, char * expression)

Short description.

Parameters:
tableId  
indexName  
expression  

xbShort xbDatabase::GetIndexDesc (const char * tableId, const char * indexName, char * desc)

Short description.

Parameters:
tableId  
indexName  
desc  

xbShort xbDatabase::GetIndexNodeSize (const char * tableId, const char * indexName, xbShort * nodeSize)

Short description.

Parameters:
tableId  
indexName  
nodeSize  

xbShort xbDatabase::GetIndexType (const char * tableId, const char * indexName, char * type)

Short description.

Parameters:
tableId  
indexName  
type  

xbShort xbDatabase::GetIndexName (const char * tableId, xbShort indexNum, char * name)

Short description.

Parameters:
tableId  
indexNum  
name  

xbShort xbDatabase::GetIndexUnique (const char * tableId, xbShort indexNum, bool * unique)

Short description.

Parameters:
tableId  
indexNum  
unique  

xbShort xbDatabase::GetIndexExpression (const char * tableId, xbShort indexNum, char * expression)

Short description.

Parameters:
tableId  
indexNum  
expression  

xbShort xbDatabase::GetIndexDesc (const char * tableId, xbShort indexNum, char * desc)

Short description.

Parameters:
tableId  
indexNum  
desc  

xbShort xbDatabase::GetIndexNodeSize (const char * tableId, xbShort indexNum, xbShort * nodeSize)

Short description.

Parameters:
tableId  
indexNum  
nodeSize  

xbShort xbDatabase::GetIndexType (const char * tableId, xbShort indexNum, char * type)

Short description.

Parameters:
tableId  
indexNum  
type  

xbShort xbDatabase::AddIndex (const char * tableId, xbShort indexNum, const char * indexName, bool unique, const char * expression, const char * desc, xbShort nodeSize, const char * type)

Short description.

Parameters:
tableId  
indexNum  
indexName  
unique  
expression  
desc  
nodeSize  
type  

xbShort xbDatabase::RemoveIndex (const char * tableId, xbShort indexNum)

Short description.

Parameters:
tableId  
indexNum  

xbShort xbDatabase::RemoveIndex (const char * tableId, const char * indexName)

Short description.

Parameters:
tableId  
indexName  

xbShort xbDatabase::ChangeIndex (const char * tableId, xbShort indexNum, const char * indexName, bool unique, const char * expression, const char * desc, xbShort nodeSize, const char * type)

Short description.

Parameters:
tableId  
indexNum  
indexName  
unique  
expression  
desc  
nodeSize  
type  

bool xbDatabase::IndexExists (const char * tableId, xbShort indexNum)

Short description.

Parameters:
tableId  
indexNum  

void xbDatabase::RemoveIndexFile (const char * tableId, xbShort indexNum)

Short description.

Parameters:
tableId  
indexNum  

xbShort xbDatabase::LookupReport (xbShort reportNum)

Short description.

Parameters:
reportNum  

xbShort xbDatabase::GetReportTableId (xbShort reportNum, char * tableId)

Short description.

Parameters:
reportNum  
tableId  

xbShort xbDatabase::GetReportTitle (xbShort reportNum, char * title)

Short description.

Parameters:
reportNum  
title  

xbShort xbDatabase::GetReportIndexNum (xbShort reportNum, xbShort * indexNum)

Short description.

Parameters:
reportNum  
indexNum  

xbShort xbDatabase::GetReportMinKey (xbShort reportNum, char * minKey)

Short description.

Parameters:
reportNum  
minKey  

xbShort xbDatabase::GetReportMaxKey (xbShort reportNum, char * maxKey)

Short description.

Parameters:
reportNum  
maxKey  

xbShort xbDatabase::GetReportQuery (xbShort reportNum, char * query)

Short description.

Parameters:
reportNum  
query  

xbShort xbDatabase::GetReportFieldList (xbShort reportNum, char * fieldList)

Short description.

Parameters:
reportNum  
fieldList  

xbShort xbDatabase::GetReportFormat (xbShort reportNum, char * format)

Short description.

Parameters:
reportNum  
format  

xbShort xbDatabase::AddReport (const char * tableId, xbShort reportNum, const char * title, xbShort indexNum, const char * minKey, const char * maxKey, const char * query, const char * fieldList, const char * format)

Short description.

Parameters:
tableId  
reportNum  
title  
indexNum  
minKey  
maxKey  
query  
fieldList  
format  

xbShort xbDatabase::RemoveReport (xbShort reportNum)

Short description.

Parameters:
reportNum  

xbShort xbDatabase::ChangeReport (const char * tableId, xbShort reportNum, const char * title, xbShort indexNum, const char * minKey, const char * maxKey, const char * query, const char * fieldList, const char * format)

Short description.

Parameters:
tableId  
reportNum  
title  
indexNum  
minKey  
maxKey  
query  
fieldList  
format  

xbDbf * xbDatabase::OpenDbf (const char * tableId)

Short description.

Parameters:
tableId  

xbDbf * xbDatabase::CreateDbf (const char * tableId, xbShort overlay = XB_DONTOVERLAY)

Short description.

Parameters:
tableId  
overlay  

xbShort xbDatabase::Pack (const char * tableId = 0, void(* packStatusFunc)(xbLong itemNum,xbLong numItems) = 0, void(* indexStatusFunc)(xbLong itemNum,xbLong numItems) = 0)

Short description.

Parameters:
tableId  
packStatusFunc  
indexStatusFunc  

xbShort xbDatabase::ReIndex (const char * tableId = 0, xbShort indexNum = -1, void(* statusFunc)(xbLong itemNum,xbLong numItems) = 0)

Short description.

Parameters:
tableId  
indexNum  
statusFunc  

xbShort xbDatabase::Zap (const char * tableId = 0)

Short description.

Parameters:
tableId  

The documentation for this class was generated from the following files:
  • database.h
  • database.cpp

Copyright © 2000-2002 Derry Bryson. All Rights Reserved.