nsfdb.h

IBM Lotus C++ API 7.0a for IBM Lotus Notes/Domino Directory Release --------- ------------------

STATUS LNPUBLIC NSFDbLocateByReplicaID (DBHANDLE hDB, DBID far *ReplicaID, char far *retPathName, WORD PathMaxLen);
STATUS LNPUBLIC NSFDbStampNotes (DBHANDLE hDB, HANDLE hTable,
									const char far *ItemName, WORD ItemNameLength,
									void far *Data, WORD DataLength);
STATUS LNPUBLIC NSFDbStampNotesMultiItem (DBHANDLE hDB, HANDLE hTable, HANDLE hInNote);
STATUS LNPUBLIC NSFDbDeleteNotes (DBHANDLE hDB, HANDLE hTable, UNID far *retUNIDArray);
STATUS LNPUBLIC NSFDbUserNameGet (DBHANDLE hDB, char far *retUserName, WORD BufferLength);
STATUS LNPUBLIC NSFDbGetNamesList(DBHANDLE hDB, DWORD Flags, HANDLE *rethNamesList);
void LNPUBLIC NSFDbAccessGet(DBHANDLE hDB, WORD far *retAccessLevel, WORD far *retAccessFlag);
STATUS LNPUBLIC NSFDbRename (const char far *from, const char far *to);
STATUS LNPUBLIC NSFDbClassGet (DBHANDLE hDB, WORD far *retClass);
STATUS LNPUBLIC NSFDbModeGet (DBHANDLE hDB, USHORT far *retMode);
STATUS LNPUBLIC NSFDbGetUserActivity(DBHANDLE hDB, DWORD Flags, DBACTIVITY far *retDbActivity,
									HANDLE far *rethUserInfo, WORD far *retUserCount);
STATUS LNPUBLIC NSFDbCloseSession (DBHANDLE hDB);
STATUS LNPUBLIC NSFDbReopen (DBHANDLE hDB, DBHANDLE far *rethDB);
STATUS LNPUBLIC NSFDbMajorMinorVersionGet (DBHANDLE hDB, WORD far *retMajorVersion, 
											 WORD far *retMinorVersion);
STATUS LNPUBLIC NSFDbItemDefTable (DBHANDLE hDB,ITEMDEFTABLEHANDLE far *retItemNameTable);
STATUS LNPUBLIC NSFDbItemDefTableExt (DBHANDLE hDB,ITEMDEFTABLEEXTHANDLE far *retItemNameTable);
STATUS LNPUBLIC NSFDbGetBuildVersion (DBHANDLE hDB,WORD far *retVersion);
STATUS LNPUBLIC NSFDbSpaceUsage (DBHANDLE hDB, DWORD far *retAllocatedBytes, DWORD far *retFreeBytes);
STATUS LNPUBLIC NSFDbSpaceUsageScaled (DBHANDLE hDB, DWORD far *retAllocatedGranules, DWORD far *retFreeGranules, DWORD far *retGranularity);
DWORD LNPUBLIC NSFDbGetOpenDatabaseID (DBHANDLE hDB);
STATUS LNPUBLIC NSFGetServerStats(char far *ServerName, char far *Facility, char far *StatName, HANDLE far *rethTable, DWORD far *retTableSize);
STATUS LNPUBLIC NSFGetServerLatency(char far *ServerName, DWORD Timeout,
								DWORD far *retClientToServerMS,
								DWORD far *retServerToClientMS,
								WORD far *ServerVersion);
STATUS LNPUBLIC NSFRemoteConsole(char far *ServerName, char far *ConsoleCommand, HANDLE far *hResponseText);

STATUS LNPUBLIC NSFBuildNamesList(char *UserName, DWORD dwFlags, HANDLE *rethNamesList);
STATUS LNPUBLIC NSFDbClearReplHistory(DBHANDLE hDb, DWORD dwFlags);
STATUS LNPUBLIC NSFDbGetModifiedUnreadTables(DBHANDLE hDB, char* UserName, WORD UserNameLen, TIMEDATE Since, TIMEDATE *Until, HANDLE *hRead, HANDLE *hUnread);
STATUS LNPUBLIC NSFDbUpdateUnread (DBHANDLE hDataDB, HANDLE hUnreadList);
STATUS LNPUBLIC NSFDbGetUnreadNoteTable(DBHANDLE hDB,
						char far *UserName, WORD UserNameLength, BOOL fCreateIfNotAvailable,
						HANDLE far *rethUnreadList);
STATUS LNPUBLIC NSFDbGetUnreadNoteTable2(DBHANDLE hDB,
						char far *UserName, WORD UserNameLength, BOOL fCreateIfNotAvailable, BOOL fUpdateUnread,
						HANDLE far *rethUnreadList);
STATUS LNPUBLIC NSFDbSetUnreadNoteTable(DBHANDLE hDB, char far *UserName, WORD UserNameLength,
						BOOL fFlushToDisk, HANDLE hOriginalUnreadList, HANDLE hUnreadList);
STATUS LNPUBLIC NSFDbGetObjectStoreID(DBHANDLE dbhandle, BOOL far *Specified, DBID far *ObjStoreReplicaID);
STATUS LNPUBLIC NSFDbSetObjectStoreID(DBHANDLE dbhandle, DBID far *ObjStoreReplicaID);
STATUS LNPUBLIC NSFDbFilter(DBHANDLE hFilterDB, NOTEHANDLE hFilterNote,
								HANDLE hNotesToFilter, BOOL fIncremental,
								void far *Reserved1, void far *Reserved2,
								char far *DbTitle, char far *ViewTitle,
								void far *Reserved3, void far *Reserved4,
								HANDLE hDeletedList,
								HANDLE hSelectedList);
STATUS LNPUBLIC NSFDbCompact(const char far *Pathname, WORD Options, DWORD far *retStats);
STATUS LNPUBLIC NSFDbCompactExtended(const char *Pathname, DWORD Options, DWORD *retStats);
/*	Define flags for NSFFolderGetIDTable */
#define DB_GETIDTABLE_VALIDATE 0x00000001	/*	If set, return only "validated" noteIDs */
STATUS LNPUBLIC NSFFolderGetIDTable(HANDLE hViewDB, HANDLE hDataDB, NOTEID ViewNoteID, DWORD Flags, HANDLE *hTable);
STATUS LNPUBLIC NSFGetFolderChanges(DBHANDLE hViewDB, DBHANDLE hDataDB, NOTEID ViewNoteID, TIMEDATE *Since, DWORD Flags, 
											HANDLE *AddedNoteTable, HANDLE *RemovedNoteTable);
typedef STATUS (LNCALLBACKPTR NSFGETALLFOLDERCHANGESCALLBACK) (void *Param, UNID *NoteUNID, HANDLE AddedNoteTable, HANDLE RemovedNoteTable);
STATUS LNPUBLIC NSFGetAllFolderChanges(HANDLE hViewDB, HANDLE hDataDB, TIMEDATE *Since, DWORD Flags, 
											NSFGETALLFOLDERCHANGESCALLBACK Callback, void *Param, TIMEDATE *Until);
#define MAX_ITEMDEF_SEGMENTS 25

typedef struct {
	DWORD	Items;			/* number of items in the table */
	DWORD	ItemDefArray;   /* Memory handle of ITEM_DEFINITION_EXT structures */
	DWORD	NumSegments;	/* Number of non-null segments in ItemNameSegs */
	HANDLE	ItemNameSegs[MAX_ITEMDEF_SEGMENTS]; /* Segments of packed text */
	DWORD	ItemNameSegLengths[MAX_ITEMDEF_SEGMENTS];
							/* Length of each non-null text segment */
} ITEM_DEFINITION_TABLE_EXT;

typedef struct {
	DWORD	ItemOffset;			/* offset into ItemNameSegs to item name */
	WORD	ItemType;			/* default data type of the item */
	WORD	ItemNameLength;		/* length of the item's name */
} ITEM_DEFINITION_EXT;

typedef struct {
	DWORD	Items;
	void	*pItemDefArray;
	char	*ItemText[MAX_ITEMDEF_SEGMENTS];
	DWORD	NumSegments;
	DWORD	ItemNameSegLengths[MAX_ITEMDEF_SEGMENTS];
} ITEM_DEFINITION_TABLE_LOCK;

/* Accessor routines for item name table returned by NSFDbItemDefTableExt. */
STATUS LNPUBLIC NSFItemDefExtLock(ITEM_DEFINITION_TABLE_EXT *ItemDefTable, ITEM_DEFINITION_TABLE_LOCK *ItemDefTableLock);
STATUS LNPUBLIC NSFItemDefExtUnlock(ITEM_DEFINITION_TABLE_EXT *ItemDefTable, ITEM_DEFINITION_TABLE_LOCK *ItemDefTableLock);
STATUS LNPUBLIC NSFItemDefExtFree(ITEM_DEFINITION_TABLE_EXT *ItemDeftable);
STATUS LNPUBLIC NSFItemDefExtEntries(ITEM_DEFINITION_TABLE_LOCK *ItemDefTableLock, DWORD *NumEntries);
STATUS LNPUBLIC NSFItemDefExtGetEntry(ITEM_DEFINITION_TABLE_LOCK *ItemDefTableLock, DWORD ItemNum, 
										WORD *ItemType, WORD *ItemLength, char **ItemName);

STATUS LNPUBLIC NSFBackupStart(DBHANDLE hDB, DWORD Flags, HANDLE *BackupContext, DWORD *FileSizeLow, DWORD *FileSizeHigh);
STATUS LNPUBLIC NSFBackupStop(DBHANDLE hDB, HANDLE BackupContext);
#define BACKUPEND_ABORT		0x00000001			/* Abort curent database backup */
STATUS LNPUBLIC NSFBackupEnd(DBHANDLE hDB, HANDLE BackupContext, DWORD Options);
STATUS LNPUBLIC NSFBackupSetHighWaterMark(DBHANDLE hDB, HANDLE BackupContext, 
											DWORD HighWaterMarkLow, DWORD HighWaterMarkHigh);
STATUS LNPUBLIC NSFBackupGetChangeInfoSize(DBHANDLE hDB,
							HANDLE hBackupContext,										
							DWORD Flags,
							DWORD *InfoSizeLow,
							DWORD *InfoSizeHigh);
STATUS LNPUBLIC NSFBackupGetNextChangeInfo(DBHANDLE hDB,
							HANDLE hBackupContext,										
							DWORD Flags,
	                        char * Buffer,
							DWORD BufferSize,
							DWORD *FilledSize);

STATUS LNPUBLIC NSFBackupStartApplyChangeInfo(HANDLE *ApplyInfoContext,
							char * CopyFilePath,
							DWORD Flags,
							DWORD InfoSizeLow,
							DWORD InfoSizeHigh);

STATUS LNPUBLIC NSFBackupApplyNextChangeInfo(
							HANDLE ApplyInfoContext,
							DWORD Flags,
							char * Buffer,
							DWORD BufferSize);
#define APPLYEND_ABORT		0x00000001			/* Abort current change info appilcation */
STATUS LNPUBLIC NSFBackupEndApplyChangeInfo(HANDLE ApplyInfoContext,
							DWORD Flags);

STATUS LNPUBLIC NSFBringDatabaseOnline(const char far *	dbPath, 
										DWORD	options);

#define OFFLINE_NODELETE		0x00000001		/* Don't delete database file */
#define OFFLINE_KEEP_ACCESS_ENTITIES 0x00000002 /* Don't delete DB2 access entities */

STATUS LNPUBLIC NSFTakeDatabaseOffline(const char far *	dbPath, 
										DWORD	WaitTime,
										DWORD	options);
STATUS LNPUBLIC NSFDbGetLogInfo(DBHANDLE hDb, 
								DWORD Flags, 
								BOOL * LOGGED,
								UNID * LogID,
								UNID * Dbiid,
								DWORD * LogExtent);

#define DB2BACKUP_FASTCONNECT		0x1
#define DB2BACKUP_NEWREPLICA		0x2

#define DB2BACKUP_COPY_REPLACE			 0x8
#define DB2BACKUP_COPY_DELETE_SRC		 0x10
#define DB2BACKUP_COPY_ISOLATE           0x20
#define DB2BACKUP_COPY_CLOSE             0x40
#define DB2BACKUP_COPY_NONRECOVERABLE    0x80
#define DB2BACKUP_COPY_IGNORE_NIF        0x100
#define DB2BACKUP_COPY_VENDOR_LOAD       0X200

#define DB2BACKUP_LINKS_VERIFYEXISTING  0x01
#define DB2BACKUP_LINKS_SCANSCHEMAS		0x02
#define DB2BACKUP_LINKS_QUIET           0x04

#define DB2BACKUP_NONSFID 0xffffffff

STATUS LNPUBLIC NSFDB2ReconnectNotesDatabase(const char far *  FullPath,
											 const char far *  String1,
											 DWORD  nsfid,
											 DWORD  flags);

STATUS LNPUBLIC NSFDB2RegenerateLinks (DWORD flags);

STATUS LNPUBLIC NSFDB2ListNSFDB2Databases (HANDLE *pHDbList, void far **pDbList, const char far* tablespaceName);

STATUS LNPUBLIC NSFDB2FastCopy(
							   const char far*  srcDB2Database,
							   const char far*  tgtDB2Database, 
							   const char far*  sourceNSF,
							   const char far*  targetNSF,
							   const char far*  groupName, 
							   const char far*  loadParameter,
							   DWORD            WaitTime,
							   DWORD			flags,
							   DWORD            flags2);

STATUS LNPUBLIC NSFDB2GetDbInfoValidity  (const char* filePath,
										  char* Schema,
										  DWORD szSchema,
										  char* tableSpace,
										  DWORD szTableSpace,
										  char* actualTableSpace,
										  DWORD szActualTableSpace,
										  BOOL*	schemaExists,
										  BOOL* tsExists,
										  BOOL* tsMismatch,
										  DWORD flags);
/* Define NSF Group Properties */
#define DB2NSF_GROUP_PROPERTY_CLASS			1

STATUS LNPUBLIC  NSFGetNSFDB2GroupProperty( const char* group, DWORD infotype, void far *buffer, DWORD *size);

/* Definition of the log restore callback function that the backup */

/* utility will have to provide for archive logging.               */
typedef STATUS (LNCALLBACKPTR LOGRESTORECALLBACKFUNCTION)(UNID *LogID, DWORD LogNumber, char *LogSegmentPathName);

typedef enum {
	MediaCallback_NoteUpdate = 0x01,	/* Update of existing Note */
	MediaCallback_NoteInsert = 0x02,	/* Addition of new note */
	MediaCallback_NoteDelete = 0x04,	/* Delete of note */
	MediaCallback_CLR        = 0x08		/* Event is the undo of an action due to some failure */
} MediaCallbackFlags;


typedef struct {
	WORD			InfoSize;	/* Size of this structure, use this to determine if future fields are avail */ 
	NOTEID			NoteId;		/* NoteID for note being altered */
	NOTEHANDLE		hNote;		/* Handle to note being retrieved */
	TIMEDATE		TranTime;	/* Time the transaction ran for which you are being called */
	char far*		UserName;	/* If avail, else a pointer to "" */
	char far*		PathName;	/* Path & file name of DB */
} NOTE_RESTORE_CALLBACK_INFO;

/* Definition of the note restore callback function that the backup/archive */
/* utility will have to provide for monitoring notes during Media Recovery  */
typedef STATUS (LNCALLBACKPTR NOTERESTORECALLBACKFUNCTION)(	DWORD			state_flags,
															void far *		userParm,
															NOTE_RESTORE_CALLBACK_INFO far * info);


/* Log archiving API for backup utilities to call */
/* Possible values returned from NSFGetTransLogStyle */ 
#define TRANSLOG_STYLE_CIRCULAR 0  /* Circular logging is in effect */
#define TRANSLOG_STYLE_ARCHIVE  1  /* Archive logging is in effect */
#define TRANSLOG_STYLE_LINEAR   2  /* Linear logging is in effect */