lnsessio.hpp

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

		}
	LNSTATUS CreateDatabaseCopy
		( const LNString &srcdb_path, const LNString &srcdb_server,
		  const LNString &newdb_path, const LNString &newdb_server = "",
		  LNDatabase *newdb = 0 )
		{
			return CreateDatabaseCopyOrReplica
				(srcdb_path, srcdb_server, newdb_path, newdb_server,
				 LNCreateDatabaseOptions(), newdb, FALSE);
		}
	LNSTATUS CreateDatabaseCopy
		( const LNString &srcdb_path, const LNString &srcdb_server,
		  const LNString &newdb_path, const LNString &newdb_server,
		  const LNCreateDatabaseOptions &options, LNDatabase *newdb = 0 )
		{
			return CreateDatabaseCopyOrReplica
				(srcdb_path, srcdb_server, newdb_path, newdb_server, options,
				 newdb, FALSE);
		}
	
	LNSTATUS CreateDatabaseFromTemplate
		( const LNDatabase &templatedb, const LNString &newdb_path,
		  const LNString &newdb_server = "", LNDatabase *newdb = 0 )
		{
			return CreateDatabaseFromTemplate
				(templatedb, newdb_path, newdb_server, LNCreateDatabaseOptions(),
				 newdb);
		}
	LNSTATUS CreateDatabaseFromTemplate
		( const LNDatabase &templatedb, const LNString &newdb_path,
		  const LNString &newdb_server, const LNCreateDatabaseOptions &options,
		  LNDatabase *newdb = 0 );
	LNSTATUS CreateDatabaseFromTemplate
		( const LNString &templatedb_path, const LNString &templatedb_server,
		  const LNString &newdb_path, const LNString &newdb_server = "",
		  LNDatabase *newdb = 0 )
		{
			return CreateDatabaseFromTemplate
				(templatedb_path, templatedb_server, newdb_path, newdb_server,
				 LNCreateDatabaseOptions(), newdb);
		}
	LNSTATUS CreateDatabaseFromTemplate
		( const LNString &templatedb_path, const LNString &templatedb_server,
		  const LNString &newdb_path, const LNString &newdb_server,
		  const LNCreateDatabaseOptions &options, LNDatabase *newdb = 0 );

	LNSTATUS CreateDatabaseReplica
		( const LNDatabase &srcdb, const LNString &newdb_path,
		  const LNString &newdb_server = "", LNDatabase *newdb = 0 )
		{
			return CreateDatabaseCopyOrReplica
				(srcdb, newdb_path, newdb_server, LNCreateDatabaseOptions(),
				 newdb, TRUE);
		}
	LNSTATUS CreateDatabaseReplica
		( const LNDatabase &srcdb, const LNString &newdb_path,
		  const LNString &newdb_server, const LNCreateDatabaseOptions &options,
		  LNDatabase *newdb = 0 )
		{
			return CreateDatabaseCopyOrReplica
				(srcdb, newdb_path, newdb_server, options, newdb, TRUE);
		}
	LNSTATUS CreateDatabaseReplica
		( const LNString &srcdb_path, const LNString &srcdb_server,
		  const LNString &newdb_path, const LNString &newdb_server = "",
		  LNDatabase *newdb = 0 )
		{
			return CreateDatabaseCopyOrReplica
				(srcdb_path, srcdb_server, newdb_path, newdb_server,
				 LNCreateDatabaseOptions(), newdb, TRUE);
		}
	LNSTATUS CreateDatabaseReplica
		( const LNString &srcdb_path, const LNString &srcdb_server,
		  const LNString &newdb_path, const LNString &newdb_server,
		  const LNCreateDatabaseOptions &options, LNDatabase *newdb = 0 )
		{
			return CreateDatabaseCopyOrReplica
				(srcdb_path, srcdb_server, newdb_path, newdb_server, options,
				 newdb, TRUE);
		}

	LNSTATUS CreateLogEntry
		( LNLogEntry *logentry, const LNString &formname = LOG_EVENT_FORM ) const;

	LNSTATUS CreateMailMessage( LNMailMessage *message );

	LNSTATUS CreateMessageQueue
		( const LNString& mqname, LNINT quota, LNMessageQueue*newmq = 0 );
	LNSTATUS CreateMessageQueue
		( const LNString& mqname, LNMessageQueue*newmq = 0 );

	LNSTATUS DeleteDatabase( const LNString &path, const LNString &server = "" );
	LNSTATUS DeleteDatabase( LNDatabase *db );

	LNSTATUS DiscardLogEntry( LNLogEntry *logentry ) const;

	LNSTATUS ExecuteServer
		( const LNString &server, const LNString &command, 
		  LNString *response ) const;

	LNSTATUS FreeTimeSearch
		(const LNDatetimeRange &range, LNINT duration, LNDatetimes *freetime);
	LNSTATUS FreeTimeSearch
		(const LNDatetimeRange &range, LNINT duration, LNDatetimes *freetime, 
		const LNString &username) const;
	LNSTATUS FreeTimeSearch
		(const LNDatetimeRange &range, LNINT duration, LNDatetimes *freetime,
		LNText &usernames)const;
	LNSTATUS FreeTimeSearch
		(const LNDatetimes &ranges, LNINT duration, LNDatetimes *freetime);
	LNSTATUS FreeTimeSearch
		(const LNDatetimes &ranges, LNINT duration, LNDatetimes *freetime, 
		const LNString &username) const;
	LNSTATUS FreeTimeSearch
		(const LNDatetimes &ranges, LNINT duration, LNDatetimes *freetime,
		LNText &usernames) const;

	LNSTATUS GetAddressBooks
		( LNDatabaseArray *dbarray, const LNString &server = "" );

	LNSTATUS GetCalendar(LNCalendar *calendar, const LNString &server = "", 
		const LNString &dbname = "", const LNString &username = "");

	LNSTATUS GetCertifier( const LNIDFile &idfile, const LNDatetime &expiration,
		LNCertifier *cert, const LNString &password = "", const LNString &logfile = "" );
	LNSTATUS GetCertifier( const LNString &idfilepath, const LNDatetime &expiration,
		LNCertifier *cert, const LNString &password = "", const LNString &logfile = "" );

	virtual LNCLASSID GetClassID() const
		{ return LNCLASSID_LNNOTESSESSION; }

	LNDatetime GetCurrentDatetime() const;

	LNSTATUS GetDatabase
		( const LNString &path, LNDatabase *db, const LNString &server = "" );
	LNSTATUS GetDatabase
		( const char *path, LNDatabase *db, const LNString &server = "" )
		{ return GetDatabase(LNString(path), db, server); }
	LNSTATUS GetDatabase
		( const DBID &replicaid, LNDatabase *db, const LNString &server = "" );
	LNSTATUS GetDatabase( DBHANDLE handle, LNDatabase *db );

	LNDBOPENFLAGS GetDatabaseOpenFlags() const;
	
	LNSTATUS GetDatabases
		( LNDatabaseArray *dbarray, const LNString &server = "",
		  const LNString &dir = "",
		  LNGETDBFLAGS flags = LNGETDBFLAGS_DATABASES | LNGETDBFLAGS_RECURSE );

	LNString GetDataDirectory();

	LNString GetEnvironmentString( const LNString &variable ) const;
	
	LNSINT GetEnvironmentValue( const LNString &variable ) const;

	LNSTATUS GetIDFile( const LNString &filepath, LNIDFile *idfile ) const;

	LNInternational GetInternational() const;

	LNSTATUS GetLocationDocument( LNDocument *doc );

	LNSTATUS GetMailDatabase( LNDatabase *db );

	LNMAILPROGRAM GetMailProgram();

	LNString GetMailServer();

	LNSTATUS GetMessageQueue( const LNString &mqname, LNMessageQueue *mq );

	LNSTATUS GetNotesVersion
		( LNNOTESVERSION *version, const LNString &server = "" );

	LNString GetPort() const { return Port; }

	LNText GetPorts();

	LNRTPARSERERRORHANDLER GetRTParserErrorHandler() const;

	LNSTATUS GetServerAddin
		( const LNString &task, const LNString &text, LNServerAddin *AddinPtr);

	LNSTATUS GetServerNames( LNText *names ) const;

	LNBOOL GetSignHotspotsInRichText() const;

	LNBOOL GetThrowAllErrors();
	
	LNString GetUserName()
		{ return GetUserNameText(); }

	LNINT GetViewFolderCacheSize();

	LNSTATUS Init( int argc, char *argv[] )
		{ return Initialize(LNGetAPIProgramVersion(), argc, argv, TRUE, 0); }
	LNSTATUS Init(LNBOOL initnotes)
		{ return Initialize(LNGetAPIProgramVersion(), 0, 0, initnotes, 0); }
#if !defined UNIX && !defined MAC
	LNSTATUS Init(const char *pathname = 0 )
		{ return Initialize(LNGetAPIProgramVersion(), 0, 0, TRUE, pathname); }
#endif

	LNSTATUS InitThread();

	LNBOOL IsInitialized() const;

	LNBOOL IsServerAvailable(const LNString &server) const;

	LNBOOL IsThreadInitialized() const;

	LNSTATUS Replicate( const LNString &server ) const;
	LNSTATUS Replicate
		( const LNString &server, const LNReplicationOptions &options,
		  LNReplicationStatistics *stats = 0 ) const;

	LNSTATUS SetDatabaseOpenFlags( LNDBOPENFLAGS flags );

	LNSTATUS SetEnvironmentString
		( const LNString &variable, const LNString &string ) const;
	
	LNSTATUS SetEnvironmentValue( const LNString &variable, LNSINT value ) const;

	LNSTATUS SetPort( const LNString &port )
		{ return SetPortName(port); }

	LNRTPARSERERRORHANDLER SetRTParserErrorHandler(LNRTPARSERERRORHANDLER fn);

	void SetSignHotspotsInRichText( LNBOOL flag = TRUE );

	void SetThrowAllErrors( LNBOOL flag );

	LNSTATUS SetViewFolderCacheSize(LNINT cacheSize);
	
	LNSTATUS Term( LNBOOL report_leaks = FALSE );
	
	LNSTATUS TermThread();

private:
	LNDBOPENFLAGS DatabaseOpenFlags;
	char *DataDirectory;
	WORD Flags;
	LNVERSION LibraryVersion;
	LNMAILPROGRAM MailProgram;
	LNNOTESVERSION NotesVersion;
	LNString Port;
	LNObjectList Objects;
	LNRTPARSERERRORHANDLER RTParserErrorHandler;
	LNServerAddin *ServerAddinPtr;
	LNBOOL SignHotspotsInRichText;
	LNBOOL ThrowAllErrors;
	LNINT ThrowAllErrorsSequence;
	char *UserName;

	// copy constructor and assignment operator are private (and undefined) to
	// prevent anyone from using them

	LNNotesSession( const LNNotesSession &session );
	LNNotesSession & operator=( const LNNotesSession &session );

	// other private functions

	LNSTATUS AddObjectToList( LNNotesClass *object )
		{ return Objects.AddObject(object); }

	LNString GetUserNameText();

	LNSTATUS Initialize
		( LNVERSION version, int argc, char *argv[], LNBOOL initnotes, const char *pathname );

	LNSTATUS ConstructNetPathname
		( const LNString &path, const LNString &server, char *buffer ) const;

	LNSTATUS CreateDatabaseCopyOrReplica
		( const LNDatabase &srcdb, const LNString &newdb_path,
		  const LNString &newdb_server, const LNCreateDatabaseOptions &options,
		  LNDatabase *newdb, LNBOOL replica );
	LNSTATUS CreateDatabaseCopyOrReplica
		( const LNString &srcdb_path, const LNString &srcdb_server,
		  const LNString &newdb_path, const LNString &newdb_server,
		  const LNCreateDatabaseOptions &options, LNDatabase *newdb,
		  LNBOOL replica );

	LNSTATUS SetPortName( const LNString &port );
};

#endif	//LNSESSIO_HPP