Engine Help Kategorie: NotesSystem
Gefilterte Übersicht der Engine-Help-Dokumentation.
@Accessed
Gibt den Zeitpunkt des letzten Zugriffs des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@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 …
@CloseAgent
Schließt den Agent(Filter) mit dem AGENTHANDLE AGENTHANDLE1 und gibt den geschlossenen AGENTHANDLE zurück.
@CompileFormula
Compiliert TEXT1 einen Notes-Formel-Text in das Notes-Formel-Compilat (CNFORMULA) und gibt dieses zurück. TEXT2 wird für Column-Formulas benötigt und muß den Column-Item-Name enthalten. Beispiel @CompileFormula(TEXT1): C …
@Created
Gibt den Zeit/Datums-Wert (TD) der Erstellung des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@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 …
@DecompileFormula
Decompiliert die binäre Notes-Formel (CNFORMULA) CNFORMULA1 in den Notes-Formel Text. FN2 gibt an ob es sich um eine Ansichts-Selektions-Formel (=1) handelt oder nicht (=0). Bei der Syntax mit einem Parameter wird davon …
@DeleteEnvironment
Löscht die Umgebungsvariable TEXT TEXT1 physikalisch aus der NOTES.INI. ReturnWert: 1 = Variable konnte gelöscht werden. 0 = Varaible nicht vorhanden. @Errro... = Es ist ein Fehler aufgetretten, die Variable wurde nicht …
@Environment
Liefert den Wert der Umgebungsvariable TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück.
@ExecuteAgent
Diese @Function führt den Agent mit dem AGENTHANDLE AGENTHANDLE1 entweder gegen alle Dokumente (Ohne Parameter NOTEHANDLE NOTEHANDLE3) der DB, in der sich der Agent befindet, oder gegen ein einzelnes Dokument, mit dem NO …
@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 …
@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 …
@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 …
@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 …
@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 …
@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 …
@GetDocPrivileges
Gibt eine FLOATLIST der zu dem Dokument mit dem NOTEHANDLE NOTEHANDLE1 gehörenden Privilegien zurück. Hat das Dokument keine Privilegien so hat die Liste 0 Elemente.
@GetFieldComponents
Gibt die Komponenten einer VSPECDNFIELD DNFIELD1 Variable - also eines Feldes in einer Maske - zurück. Die Parameter PARAMETER2, PARAMETER3, PARAMETER4 und PARAMETER5 sind reserviert, TEXTLIST KEYWORDS6 enthält die evtl. …
@GetNoteClass
Gibt die NOTECLASS (siehe NOTECLASSES) des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück. FN NOTECLASS: DEC BIT Bedeutung 00000 XX No Notes keine Dokumente 00001 01 Documents Daten-Dokumente 00002 02 …
@GetNoteDB
Holt den DBHANDLE DBHANDLE1 aus dem Dokument mit dem NOTEHANDLE NOTEHANDLE1. Zurückgegeben wird der DBHANDLE1 des Dokumentes oder ein ERROR.
@GetNoteID
Gibt die NoteID (ID) des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück. HINWEIS: Nur Dokumente, die aus einer Datenbank geöffnet wurden, haben eine NoteID. Beipiel: @GetNoteID(NOTEHANDLE1) DBHANDLE:=@OpenDB("TEST.NSF") …
@GetNoteOID
Gibt die OID des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@GetNotesErrorString
Gibt zu einem Notes-Error-Status-Code (FN1) den dazugehörigen Fehlermeldungs-Text zurück.
@GetNoteUID
Gibt die UID des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@GetOIDComponents
Gibt die Komponenten der OID OID in TD RETTDDBID, TD RETTDNOTE, TD RETTDINSTANCETD und FLOAT RETFLOATINSTANCENUMBER zurück. TD RETTDDBID ist die Datenbank ID der Dantenbank, in der das Dokument erstellt wurde. TD RETTDNO …
@GetOSPath
Gibt den physikalischen/lokalen Pfad (OSPATH) zum relativen NOTESPATH/NOTESPATHLIST NOTESPATH1/NOTESPATHLIST1 zurück. Directory- und Datenbank-Verbindungen werden dabei berücksichtigt. Wird eine NOTESPATHLIST als Input-P …
@GetRemoteDBPathByRID
Es wird auf dem Server mit dem ServerName TEXT TEXTSERVERNAME die erste DB mit der ReplikID RID DBRID gesucht und der NotesPath (TEXT) auf diese zurückgegeben. Mit diesem NotesPath kann die gefundene DB geöffnet werden. …
@Modified
Gibt den Zeitpunkt der letzten Änderung des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@NewOID
Liefert eine OID für ein neues Dokument einer Datenbank mit dem DBHANDLE DBHANDLE1 zurück.
@OpenAgent
Öffnet in der Datenbank mit dem DBHANDLE DBHANDLE1 den Agent(Filter) mit dem Namen TEXT TITLE2. Diese @Function ist erst ab Notes Version 4.5 verfügbar. ReturnWert: Wurde die @Function erfolgreich durchgeführt wird ein A …
@OpenDesignNote
Öffnet das erste Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1, das der NOTECLASSES NOTECLASSES3 entspricht und den TEXT TITLE2 hat, und gibt den NOTEHANDLE NOTEHANDLE4 zurück. Hinweis: Änderungen an einem Design- …
@PushAndReplace
Repliziert die Datenbank mit dem DBHANDLE FROMDBHANDLE1 mit der Datenbank mit dem DBHANDLE TODBHANDLE2 in der Richtung von FROMDBHANDLE1 nach TODBHANDLE2, wobei nur die Dokumente repliziert werden, die der Notes-Kompatib …
@PushWithFormula
Repliziert die Datenbank mit dem DBHANDLE FROMDBHANDLE1 mit der Datenbank mit dem DBHANDLE TODBHANDLE2 in der Richtung von FROMDBHANDLE1 nach TODBHANDLE2, wobei nur die Dokumente repliziert werden, die der Notes-Kompatib …
@ReorgACLPrivileges
Die leeren Elemente der TEXTLIST PRIVNAMES2 werden entfernt und im Parameter RETUSERPRIVS3 zurückgegeben. Die korrespondierenden Privilegienverweise in der TEXTLIST USERPRIVS1 werden angepaßt und im Parameter RETPRIVNAME …
@Replicate
Repliziert die Datenbank mit dem DBHANDLE DBHANDLE1 mit der Datenbank mit dem DBHANDLE DBHANDLE2. FNLIST FNLIST3 ist eine Liste mit Rechten bei der das erste Element die Rechte der Replizierung in der ersten Datenbank an …
@ReplicateWithFormula
Repliziert die Datenbank mit dem DBHANDLE DBHANDLE1 mit der Datenbank mit dem DBHANDLE DBHANDLE2, wobei nur die Dokumente repliziert werden, die der Notes-Kompatiblen Selection-Formula TEXT/TEXTLIST FORMULA3 entsprechen. …
@ReplicateWithFormulaWithFieldException
Repliziert die Datenbank mit dem DBHANDLE DBHANDLE1 mit der Datenbank mit dem DBHANDLE DBHANDLE2, wobei nur die Dokumente repliziert werden, die der Notes-Kompatiblen Selection-Formula TEXT FORMULA3 entsprechen. FNLIST F …
@ReplicateWithServer
Es die Datenbanken des lokalen Notes-Servers mit dem entfernten Notes-Server TEXT SERVERNAME2 über den Port TEXT PORTNAME1 durch den Notes-Replikator (nicht der Engine-Replikator) repliziert. Über FN OPTIONS3 können Opti …
@RTAddDocLink
Fügt eine Dokumentenverbindung (DocLink) auf das Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 aus der Ansicht mit dem VIEWHANDLE VIEWHANDLE2 und dem NOTEHANDLE NOTEHANDLE3 in das Richtext-Feld RT RTFIELD4 ein. De …
@RTAddHotSpotTextDocLink
Fügt eine Dokumentenverbindung (DocLink) auf das Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 aus der Ansicht mit dem VIEWHANDLE VIEWHANDLE2 und dem NOTEHANDLE NOTEHANDLE3 in das Richtext-Feld RT RTFIELD4 ein. De …
@ScanDB
Sucht alle Dokumente in der Datenbank mit dem DBHANDLE DBHANDLE1 die der Selection-Formula TEXT FORMULA2 entsprechen, vor dem Zeitpunkt TD SINCE3 in dieser DB geändert wurden und in NOTECLASSES NOTECLASSES4 enthalten sin …
@ScanDBDeleted
Sucht alle gelöschten Dokumente in der Datenbank mit dem DBHANDLE DBHANDLE1 und der/den NOTECLASS(EN) NOTECLASSES2. Der optionale Parameter TD SINCE4 grenzt die Suche auf die Dokumente ein, die seit dem angegebenen Datum …
@ServerPing
Mit dieser @Funktion kann die Erreichbarkeit bzw. die Verfügbarkeit des Servers mit dem Namen TEXT TEXT1 geprüft werden. Return-Wert: Falls der Server antwortet wird der Workload Index (FN) des Servers zurückgegeben, and …
@SetACL
Schreibt die ACL die durch PARAMETER2-5 beschrieben wird in die Datenbank mit dem DBHANDLE DBHANDLE. Es muß in dieser ACL immer mindestens ein Eintrag mit ACL-LEVEL=6 enthalten sein. Der APIEngine-Server der die ACL schr …
@SetACLMaxINetAccess
Setzt den Maximum Internet Access der DB mit dem DBHANDLE DBHANDLE1 auf den Level FN FNLEVEL2. FNLEVEL2: 6=(Manager) Manager 5=(Developer) Entwickler 4=(Editor) Editor 3=(Author) Autor 2=(Reader) Leser 1=(Depos …