PilotDatabase Class Reference
Methods to access a database on the pilot. More...
#include <pilotDatabase.h>
Inheritance diagram for PilotDatabase:

Public Types | |
enum | { MAX_APPINFO_SIZE = 8192 } |
Public Methods | |
PilotDatabase (QObject *, const char *) | |
virtual | ~PilotDatabase () |
virtual bool | createDatabase (long creator=0, long type=0, int cardno=0, int flags=0, int version=0)=0 |
virtual int | deleteDatabase ()=0 |
virtual int | readAppBlock (unsigned char *buffer, int maxLen)=0 |
virtual int | writeAppBlock (unsigned char *buffer, int len)=0 |
virtual int | recordCount ()=0 |
virtual QValueList< recordid_t > | idList ()=0 |
virtual PilotRecord * | readRecordById (recordid_t id)=0 |
virtual PilotRecord * | readRecordByIndex (int index)=0 |
virtual PilotRecord * | readNextRecInCategory (int category)=0 |
virtual PilotRecord * | readNextModifiedRec (int *ind=NULL)=0 |
virtual recordid_t | writeRecord (PilotRecord *newRecord)=0 |
virtual int | deleteRecord (recordid_t id, bool all=false)=0 |
virtual int | resetSyncFlags ()=0 |
virtual int | resetDBIndex ()=0 |
virtual int | cleanup ()=0 |
bool | isDBOpen () const |
virtual QString | dbPathName () const=0 |
Static Public Methods | |
void | listAppInfo (const struct CategoryAppInfo *) |
Public Attributes | |
enum PilotDatabase:: { ... } | Constants |
Protected Methods | |
virtual void | openDatabase ()=0 |
virtual void | closeDatabase ()=0 |
void | setDBOpen (bool yesno) |
Detailed Description
Methods to access a database on the pilot.NOTE: It is the users responsibility to delete PilotRecords returned by PilotDatabase methods when finished with them!!
Definition at line 67 of file pilotDatabase.h.
Member Function Documentation
|
Creates the database with the given creator, type and flags on the given card (default is RAM). If the database already exists, this function does nothing. |
|
Deletes the database (by name, as given in the constructor, the database name is stored depending on the implementation of PilotLocalDatabase and PilotSerialDatabas).
|
|
Reads the application block info, returns size.
|
|
Writes the application block info.
|
|
returns the number of records in the database.
|
|
Returns a QValueList of all record ids in the database.
|
|
Reads a record from database by id, returns record length.
|
|
Reads a record from database, returns the record length.
|
|
Reads the next record from database in category 'category'.
|
|
Reads the next record from database that has the dirty flag set.
If |
|
Writes a new record to database (if 'id' == 0, one will be assigned to newRecord).
|
|
Deletes a record with the given recordid_t from the database, or all records, if The recordid_t will be ignored in this case. Return value is negative on error, 0 otherwise. |
|
Resets all records in the database to not dirty.
|
|
Resets next record index to beginning.
|
|
Purges all Archived/Deleted records from Palm Pilot database.
|
|
Returns some sensible human-readable identifier for the database. Serial databases get Pilot:, local databases return the full path. |
|
Here are some static utility functions. listAppInfo() is primarily meant for debugging, and it dumps an appinfo block to stdout. Definition at line 50 of file pilotDatabase.cc. |
The documentation for this class was generated from the following files: