C Language Development Kit/Snippets/Database/GetTotalRecords

From OptiWiki

< C Language Development Kit | Snippets | Database
Revision as of 12:45, 10 July 2009 by Jbo (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Description Get the total number of records that are stored in the database.
Syntax
long GetTotalRecords( SDBFile *dbFile );
Arguments SDBFile *dbFile

dbFile is pointer to a structure that holds information about the database. The SDBFile structure is defined as followed:

typedef struct
{
    short  sRecSz;        // record size of database
    int    fd;            // real handle to the open file
    long   lCurrRecord;   // current record number
    long   lTotalRecords; // total amount of records
    int    bOpen;         // check to see if db is open or closed
}SDBFile;
Returns
-1L Total number of records can not be determined.
>=0L The amount of records stored in the database.
Remarks The declaration of the SDBFile needs to be static to make sure all items are initialized to 0.

When the GetTotalRecords() functions returns -1L the error code can be obtained by making a call to GetDBErrorCode() function.

Example
#include "lib.h"
#include <stdio.h>
#include "database.h"  //Holds the database functions
 
void main( void )
{
    static SDBFile dbFile; // static initializes all items to 0
    long total;
 
    printf("\fOpen database\n");
    if( !CreateDatabase("file1.txt", 32, &dbFile ))
        printf("Error code = %ld\n", GetDBErrorCode());
 
    printf("Write a record\n");
    if( !WriteRecord(&dbFile,(char*)"123456789012345678901234567890\r\n",WRITE_APPEND))
        printf("Error code = %ld\n", GetDBErrorCode());
 
    if( (total = GetTotalRecords( &dbFile )) != -1L)
        printf("Error code = %ld\n", GetDBErrorCode());
    printf("Total recs = %ld\n", total);
 
    printf("Close database\n");
    CloseDatabase( &dbFile );
 
    while( 1 )
        idle();
}


Views
Personal tools