ndbpriv.h

CD_高级PALM编程

/********************************************************************
* FILE:				NDBpriv.h
*
* DESCRIPTION:	Private Native Database Interface module definitions
*
* VERSION:		1.0
**********************************************************************/

#define ndbMaxCardNum ( 2 )		// How many memory cards can there be?

// Reference count of an open database.
typedef struct _ndbDmOpenDatabaseType
{
	int refCount;
	DmOpenRef dbRef[ ndbMaxCardNum ];
} NDBDmOpenDatabaseType;

// Database types
#define addrDBType                        'DATA'
#define memoDBType						'DATA'
#define datebookDBType					'DATA'
#define toDoDBType						'DATA'

#define ndbEmptyString ("")
#define ndbSepString (",")
#define ndbSepStartSubDesc (" (")
#define ndbSepEndSubDesc (")")

// The search direction enumeration
typedef enum _ndbSearchDir
{
	ndbSearchPrev = -1,
	ndbSearchInvalid = 0,
	ndbSearchNext = 1
} NDBSearchDirEnum;

// Prototypes
static CharPtr NDBFetchStringFromPackedRecord	// (out) string
(
	CharPtr startP,			// (in) Start of region
	UInt16 index,			// (in) which to get
	UInt16 count			// (in) how many there are
);

static MemHandle NDBNewHandleFromString	// (out) string copy
(
	CharPtr string,
	Err *errP				// (in) where to place error
);
static void NDBOpenDatabase // (out) nothing
(
	NDBDatabaseEnum db,		// (in) database to open
	Err *errP				// (in) where to place error
);
static void NDBCloseDatabase // (out) nothing
(
	NDBDatabaseEnum db,		// (in) database to open
	Err *errP				// (in) where to place error
);
static DmOpenRef *NDBDatabaseRefForDatabase	// (out) db ptr
(
	NDBDatabaseEnum db,		// (in) database sought
	Err *errP				// (in) where to place error
);
static BytePtr NDBMemSearch		// (out) pointer to substr
(
	BytePtr field,				// (in) field to search
	BytePtr sub,				// (in) subfield to find
	UInt32 szField,				// (in) size of field
	UInt32 szSub				// (in) size of subfield
);
static void NDBNextSearchByString	// (out) nothing
(
	NDBRecordType *recordP,	// (in) record to search for
	Err *errP,				// (in) where to place error
	NDBSearchDirEnum dir	// (in) which way to search
);
static MemHandle NDBRecordNew // (out) handle to new record
(
	NDBDatabaseEnum db,		// (in) database to search
	CharPtr keyP,			// (in) search key
	Err *errP				// (in) where to place error
);
static MemHandle NDBGetRecordWithIndex				
(							// (out) handle to data
	NDBDatabaseEnum db,		// (in) what database?
	UInt16 index,				// (in) which record?
	Err *errP				// (in) where to place error
);
static void NDBStartSearchByString	// (out) Nothing
(
	NDBDatabaseEnum db,		// (in) database to search
	CharPtr	keyP,			// (in) key to find
	MemHandle *resultH,		// (in) where to stash results
							// (out) results of search
	Err *errP				// (in) where to place error
);

// native database functions
static MemHandle NDBMemoGetProp	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	NDBPropertyEnum prop,	// (in) property sought
	Err *errP				// (in) where to place error
);
static MemHandle NDBMemoGetText	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	Err *errP				// (in) where to place error
);
static MemHandle NDBAddrGetProp	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	NDBPropertyEnum prop,	// (in) property sought
	Err *errP				// (in) where to place error
);
static MemHandle NDBAddrGetText	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	Err *errP				// (in) where to place error
);
static MemHandle NDBTodoGetProp	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	NDBPropertyEnum prop,	// (in) property sought
	Err *errP				// (in) where to place error
);
static MemHandle NDBTodoGetText	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	Err *errP				// (in) where to place error
);
static void *NDBDateNew	// (out) Handle to string
(
	void *recordP,			// (in) record 
	Err *errP				// (in) where to place error
);
static void NDBDateFree	// (out) Handle to string
(
	void *recordP,			// (in) record 
	Err *errP				// (in) where to place error
);

static MemHandle NDBDateGetProp	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	NDBPropertyEnum prop,	// (in) property sought
	Err *errP				// (in) where to place error
);
static MemHandle NDBDateGetText	// (out) Handle to string
(
	NDBRecordType *recordP,	// (in) record 
	Err *errP				// (in) where to place error
);