ndb.h

CD_高级PALM编程

/********************************************************************
* FILE:				NDB.H
*
* DESCRIPTION:	The Native Database Interface module definitions
*
* VERSION:		1.0
**********************************************************************/

#ifndef __NDB_H
#define __NDB_H

#ifndef noErr 
#define noErr ( 0 )
#endif

typedef enum _ndbDatabaseEnum
{
	ndbInvalid = 0,
	ndbAddress,
	ndbMemo,
	ndbDatebook,
	ndbToDo,
	ndbLastDatabase				// Used internally by reference counting
} NDBDatabaseEnum;

typedef enum _ndbPropertyEnum
{
	ndbPropNameInvalid = 0,
	ndbPropNameLastName,
	ndbPropNameFirstName,
	ndbPropNameTitle,
	ndbPropNameCompany,
	ndbPropNameWork,
	ndbPropNameHome,
	ndbPropNameFax,
	ndbPropNameOther,
	ndbPropNameEmail,
	ndbPropNameMain,
	ndbPropNamePager,
	ndbPropNameMobile,
	ndbPropNameAddress,
	ndbPropNameCity,
	ndbPropNameState,
	ndbPropNameZipCode,
	ndbPropNameCountry,
	ndbPropNameNote,
	ndbPropNameTime,
	ndbPropNameDate,
	ndbPropNameDesc,
	ndbPropNamePriority,
	ndbPropNameDueDate,
	ndbPropNameCategory
} NDBPropertyEnum;

// To contain search results
typedef struct _ndbRecord
{
	NDBDatabaseEnum database;				// What database is this?
	CharPtr targetP;						// What was sought?
	MemHandle recordH;						// Current record handle (if any)
	UInt16 recordIdx;						// Current record index (if known)
} NDBRecordType;

// The errors that can occur
typedef enum _ndbErrorEnum
{
	ndbErrorInvalid = appErrorClass,
	ndbErrorSearchOver,
	ndbErrorRecordInvalid,
	ndbErrorNoPreviousRecord,
	ndbErrorLast
} NDBErrorEnum;


// prototypes
MemHandle NDBFindRecordWith
							// (out) pointer to result
(
	NDBDatabaseEnum db,		// (in) database to search
	CharPtr keyP,			// (in) search target
	Err *errP				// (in) where to place error
);
MemHandle NDBRecordGetNext	// (out) Handle to next record
(
	MemHandle recordH,		// (in) handle to current record
	Err *errP				// (in) where to place error
);
MemHandle NDBRecordGetPrev	// (out) Handle to next record
(
	MemHandle recordH,		// (in) handle to current record
	Err *errP				// (in) where to place error
);
MemHandle NDBRecordGetHandle // (out) Handle
(
	MemHandle recordH,		// (in) record handle tor return
	Err *errP				// (in) where to place error
);
MemHandle NDBRecordGetText // (out) result string
(
	MemHandle recordH,
	Err *errP				// (in) where to place error
);
void NDBRecordFree			// (out) nothing
(
	MemHandle recordH,
	Err *errP				// (in) where to place error
);
MemHandle NDBRecordGetProp	// (out) handle to string
(
	MemHandle recordH,		// (in) Record of interest
	NDBPropertyEnum prop,	// (in) desired property
	Err *errP				// (in) where to place error
);
Boolean NDBRecordIsValid	// (out) true if valid
(
	MemHandle recordH,		// (in) record to inspect
	Err *errP				// (in) where to place error
);
#endif /* NDB_H */