Engine Help Kategorie: Database
Gefilterte Übersicht der Engine-Help-Dokumentation.
@BuildNamedDocKeyLists
Diese @Function erzeugt zwei korrespondierende Listen (HUGETEXT RETHTL und IDLIST RETIDL). In der Liste HUGETEXT RETHTL werden alphabetisch sortiert die Inhalte der Felder, aus den durch die Selektionsformeln TEXT FORMUL …
@CheckHandle
Prüft, ob VIEWHANDLE/NOTEHANDLE/DBHANDLE/FILEHANDLE... VIEWHANDLE1/NOTEHANDLE1/DBHANDLE1/FILEHANDLE1... ein geöffneter Handle ist. Wenn ja wird TRUE zurückgegeben, sonst FALSE. FILEHANDLE können allerdings erst ab Versio …
@ClearFolder
Diese @Function entfernt alle Dokumente, in der DB mit dem DBHANDLE DBHANDLE1, aus dem Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2. (Die Dokumente werden nur aus dem Folder entfernt und nicht aus der DB gelöscht.) Return …
@CloseAgent
Schließt den Agent(Filter) mit dem AGENTHANDLE AGENTHANDLE1 und gibt den geschlossenen AGENTHANDLE zurück.
@CloseAttachedFile
Schließt das File-Attachment mit dem OBJECTFILEHANDLE OBJECTFILEHANDLE1 und gibt den geschlossenen OBJECTFILEHANDLE zurück. Beipiel: @CloseAttachedFile(OBJECTFILEHANDLE1) DBHANDLE1:=@OpenDB("TESTDB\\TESTDB1.NSF"); NOTEID …
@CloseDB
Schließt eine vorher geöffnete Datenbank mit dem DBHANDLE DBHANDLE1 und gibt den geschlossenen DBHANDLE1 zurück. Ab der Version 1.93 kann mit TEXT OPTIONS2 ein näheres bzw. zusätzliches Verhalten bestimmt werden. OPTIONS …
@CloseFtSearch
Schließt einen vorher geöffneten Full-Text-Search mit dem FTSEARCHHANDLE FTSEARCHHANDLE1 und gibt den geschlossenen FTSEARCHHANDLE1 zurück.
@CompactDB
Die DB mit dem NOTESPATH NOTESPATH1 wird kompaktiert. FNOPTIONS: BIT DEC HEX BEDEUTUNG 01 00001 0001 02 00002 0002 03 00004 0004 04 00008 0008 05 00016 0010 06 00032 0020 07 …
@CopyACL
Kopiert die ACL der Datenbank mit dem DBHANDLE DBHANDLE1 in die Datenbank mit dem DBHANDLE DBHANDLE2. Wenn die @Funktion erfolgreich durchgeführt wurde, ist das @Funktions-Ergebnis vom Datentyp PV. Der durchführende Serv …
@CopyDB
Kopiert die Datenbank mit dem DBHANDLE DBHANDLE4 auf eine Datenbank mit dem NOTESPATH NOTHESPATH1 und der DBCLASS DBCLASS2 und gibt einen DBHANDLE auf diese zurück. Es werden die Dokumente die der Angabe in NOTECLASSES N …
@CopyFolder
Diese @Function kopiert, in der DB mit dem DBHANDLE DBHANDLE1, den Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2 als Folder mit dem Namen TEXT NEWFOLDERNAME3. (Es werden alle Dokumente, Subfolder und das Design kopiert.) R …
@CopyNote
Kopiert das Dokument mit dem NOTEHANDLE NOTEHANDLE2 in die Datenbank mit dem DBHANDLE DBHANDLE1 und gibt den NOTEHANDLE auf dieses neue Dokument zurück. NOTEHANDLE3 ist der NOTEHANDLE des neuen Dokuments.
@CopyTemplateACL
Kopiert die Template-ACL der Datenbank mit dem DBHANDLE DBHANDLE1 als ACL in die Datenbank mit dem DBHANDLE DBHANDLE2. Template-ACL-Einträge werden in der ACL in eckigen Klammern angegeben. Diese @Funktion setzt diese Ei …
@CreateDB
Legt eine neue absolut leere Datenbank der DBCLASS DBCLASS2 unter dem NOTESPATH NOTESPATH1 an und gibt einen DBHANDLE auf diese zurück. Mit FN OVERWRITE3 kann festgelegt werden, ob eine evtl. bestehende Datenbank gleiche …
@CreateDBActivity
Startet die Protokolierung der User-Activity der Datenbank mit dem DBHANDLE DBHANDLE1. Wird NUMBER 1 zurückgegeben war die Operation erfolgreich (oder schon eine User-Activity vorhanden) sonst ERROR.
@CreateNote
Erstellt ein neues Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 zu dem NOTEHANDLE NOTEHANDLE2 und gibt den NOTEHANDLE darauf zurück.
@CreateObjectStore
Erzeugt eine neue Notes-Object-Store-Datenbank mit dem NOTESPATH NOTESPATH1. Mit dem Parameter FN BOOLOVERWRITE2 wird festgelegt, ob eine bereits existierende Notes-Object-Store-Datenbank mit diesem NOTESPATH NOTESPATH1 …
@DeleteDB
Löscht eine Datenbank mit dem NOTESPATH NOTESPATH1. Wird NUMBER 1 zurückgegeben war die Operation erfolgreich sonst ERROR.
@DeleteDBActivity
Löscht die User-Activity der Datenbank mit dem DBHANDLE DBHANDLE1. Wird NUMBER 1 zurückgegeben war die Operation erfolgreich sonst ERROR.
@DeleteDBARConnection
Löscht eine spezielle Advanced Replication Settings Verbindung zwischen dem Zielserver TEXT DESTINATIONSERVER und dem Quellserver TEXT SOURCESERVER. Der Eintrag für AnyServer (Wildcard "-") als Quellserver kann nicht gel …
@DeleteDBReplicaHistory
Löscht die Replication-History der Datenbank mit dem DBHANDLE DBHANDLE1. Wird NUMBER 1 zurückgegeben war die Operation erfolgreich sonst ERROR.
@DeleteDifferenceByFormula
Löscht Dokumente in der Datenbank mit dem DBHANDLE TODBHANDLE2 die in der Datenbank mit dem DBHANDLE FROMDBHANDLE1 nicht vorkommen. Es werden nur Dokumente berücksichtigt, deren NOTECLASS in FN NOTESCLASSES4 angegeben wu …
@DeleteNote
Löscht ein Dokument mit dem NOTEHANDLE NOTEHANDLE1 in der Datenbank mit dem DBHANDLE DBHANDLE2. Das Dokument muß zuvor geöffnet worden sein. Mit dem Löschen wird es automatisch geschlossen. In FN FNUPDFLAGS3 können Optio …
@DeleteNoteByID
Löscht das Dokument bzw. die Dokumente mit der NOTEID NOTEID2 bzw. NOTEIDLIST NOTEID2 in der Datenbank mit dem DBHANDLE DBHANDLE1. Wurde die Operation erfolgreich durchgeführt ist das @Funktions-Ergebnis die Anzahl der g …
@DeleteNoteByPosition
Löscht ein Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 in der Ansicht mit dem VIEWHANDLE VIEWHANDLE2 an der Position VIEWPOSITION/VIEWPOS VIEWPOSITION3. Das Dokument muß bzw. darf nicht geöffnet werden. Wurde di …
@FolderAddDoc
Diese @Function fügt, in der DB mit dem DBHANDLE DBHANDLE1, die Dokumente ,deren NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 angegeben werden, in den Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2 ein. ReturnWert: Wurd …
@FolderRemoveDoc
Diese @Function entfernt, in der DB mit dem DBHANDLE DBHANDLE1, die Dokumente ,deren NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 angegeben werden, aus dem Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2. (Das Dokument w …
@FtSearch
@FtSearch führt die eigentliche, über FTSEARCHHANDLE FTSEARCHHANDLE1 definierte, Suche durch. Mit dem Parameter FN FNLIMIT2 kann die Anzahl der gefundenen Dokumente limitiert werden. Wird hier 0 angegeben, werden alle Do …
@GetACL
Holt die ACL der Datenbank mit dem OSPATH OSPATH1 oder DBHANDLE DBHANDLE1 und gibt sie aufgeteilt auf TEXTLIST USERNAMES2, NUMBERLIST USERLEVEL3, TEXTLIST USERPRIVS4 und TEXTLIST PRIVNAMES5 zurück. USERNAMES2: Die ACL-Na …
@GetACLHistory
Es wird die ACL-(Veränderungs)-History der DB mit dem DBHANDLE DBHANDLE1 als TEXTLIST zurückgegeben. Beispiel @GetACLHistory(DBHANDLE1): DBHANDLE1:=@OpenDB("TEST.NSF"); @LogReport(@GetACLHistory(DBHANDLE1)); DBHANDLE1:=@ …
@GetACLMaxINetAccess
Gibt den Maximum Internet Access der DB mit dem DBHANDLE DBHANDLE1 zurück. LEVEL: 6=(Manager) Manager 5=(Developer) Entwickler 4=(Editor) Editor 3=(Author) Autor 2=(Reader) Leser 1=(Depositor) Archivar 0=(No …
@GetApiLogDocInfo
Diese @Funktion gibt den DBHANDLE DBHANDLE1 und den NOTEHANDLE NOTEHANDLE2 des aktuellen APILOG Documentes zurück. Der Return-Wert der @Funktion ist stets TRUE. Sind die Werte nicht verfügbar, wird in DBHANDLE1 und NOTEH …
@GetDBActivity
Holt das User-Activity-Protokoll der Datenbank mit dem DBHANDLE1. Das @Funktions-Ergebnis ist 1 für kein Fehler oder @ERROR. Die letzten vier Argumente der @Funktion sind Return-Parameter: In RETTDLIST2 werden die Zeiten …
@GetDBARConnection
Gibt, zu der DB mit dem DBHANDLE DBHANDLE1, die Einstellungen der Advanced Replication Connection vom Quellserver TEXT SOURCESERVER zum Zielserver TEXT DESTINATIONSERVER zurück, wenn es eine Definition für dieses Zielser …
@GetDBARConnections
Es wird in TEXTLIST TLRETDESTINATIONSERVERS die Liste der Zielserver zurückgegeben, für die in der DB mit dem DBHANDLE DBHANDLE1, Advanced Replication Settings definiert wurden. Optional kann im Parameter TEXTLIST TLRETS …
@GetDBCurrentAccess
Es wird zur DB mit dem DBHANDLE DBHANDLE1 der aktuelle Access-Level (zur Ausführungszeit des Aufrufs) und optional die aktuell geltenden Flags (NUMBER NRETFLAGS) zurückgegeben. Im Fehlerfall wird @Error zurückgegeben. US …
@GetDBDocumentCount
Es wird die Anzahl der Data-Dokumente der DB mit dem DBHANDLE DBHANDLE1 in zurückgegeben. Optional kann die Anzahl der gelöschten Dokumente FLOAT FLOATDELETEDCOUNT und die Anzahl der Design-Dokumente FLOAT FLOATDESIGNCOU …
@GetDBID
Es wird die ID der DB mit dem DBHANDLE DBHANDLE1 in zurückgegeben. Die ID ist ein TD Wert der den Zeitpunkt der Erzeugung der DB angibt.
@GetDBLaunchOptions
Gibt die Launch-DB-Optionen der DB mit dem DBHANDLE DBHANDLE1 als BitVektor(FN) zurück. In TEXTLIST TEXTLIST1 werden die Namen der Navigatoren bzw. der View zurückgegeben. In RID RID1 wird die RID der DB zurückgegeben (w …
@GetDBModified
Gibt zurück, wann die Datenbank mit dem DBHANDLE DBHANDLE1 zum letzten mal geändert wurde. Dabei steht im Rückgabewert (TD) die letzte Änderung eines Daten-Dokumentes und in TD TD1 die letzte Änderung eines Nicht-Daten-D …
@GetDBObjectStoreID
Gibt die Replika-ID (RID/DBID) der Notes-Object-Store-Datenbank zurück, die mit der Datenbank mit dem DBHANDLE DBHANDLE assoziiert ist. Im Fehlerfall wird @ERROR zurückgegeben.
@GetDBOptions
Gibt die DB-Optionen der DB mit dem DBHANDLE DBHANDLE1 als BitVektor(FN) zurück. In FN FNEXTOPTIONS werden die erweiterten Optionen der DB zurückgegeben. FNEXTOPTIONS: BIT DEC HEX BEDEUTUNG wenn gesetzt 01 000001 …
@GetDBPath
Gibt den OSPATH und den NOTESPATH der Datenbank mit dem DBHANDLE DBHANDLE1 in einer TEXTLIST zurück. Wenn die Datenbank unter Angabe eines Servers (z.B. "TEST_SERVER!!TEST.NSF") geöffnet wurde, sind beide Elemente identi …
@GetDBQuota
Gibt die DB-Quota der DB mit dem DBHANDLE DBHANDLE1 als FLOATLIST mit 4 Elementen zurück. Element Nr. Bedeutung 1 Maxium size in kB of the database 2 Actual size in kB of the database 3 Quota in kB of the databas …
@GetDBReplicaHistory
Holt die Replikations-History der Datenbank mit dem DBHANDLE DBHANDLE1. Direkt zurückgegeben wird eine TEXTLIST mit den Namen der Server/User. In RETTD1 wird eine TDLIST mit jeweils dem letzten Replikationsdatum, korresp …
@GetDBReplicaInfo
Holt die Replikations-Information über Replik-ID TD REPLICAID2, Replikations-Flags NUMBER FLAGS3, Replikations-Lösch-Intervall NUMBER CUTOFFINTERVAL4 und Replikations-Lösch-Zeitpunkt TD CUTOFFTD5 der Datenbank mit dem DB …
@GetDBSpaceUsage
Es wird die Größe der DB mit dem DBHANDLE DBHANDLE1 in Bytes zurückgegeben (aufgerundet auf volle MBytes). Optional kann die Anzahl der benutzten (FLOAT FLOATALLOC) bzw. der freien Bytes (FLOAT FLOATFREE) sowie die proze …
@GetDBTitle
Gibt den Datenbanktitel und die Datenbank-Kategorien der Datenbank mit dem DBHANDLE DBHANDLE1 zurück. Der Rückgabe-Wert ist vom Typ TEXTLIST bei der im ersten Element der Titel steht und für jede vorhandene Kategorie ein …
@GetDBVersion
Gibt die FN Major-Version (ODS-Version) der Datenbank mit dem DBHANDLE DBHANDLE1 zurück. Im optionalem Parameter FNRETMINVERSION wird die Minor-Version der Datenbank zurückgegeben.
@GetFolderCount
Diese @Function gibt die Anzahl der Dokumente zurück, die sich in der DB, mit dem DBHANDLE DBHANDLE1 in dem Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2, befinden. ReturnWert: Wurde die @Function erfolgreich durchgeführt …