Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@OpenNoteByUID
Öffnet das Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 und der UID UID2 und gibt den NOTEHANDLE NOTEHANDLE3 zurück. FNOPTIONS4: BIT DEC HEX BEDEUTUNG wenn gesetzt 01 00000001 00000001 Open Summary on …
@OpenNTComPort
Öffnet das DEVICE mit dem OSCOMPORTNAME OSCOMPORTNAME und gibt einen OSCOMHANDLE darauf zurück. Nur für Engine unter Windows! Beipiel: @OpenNTComPort(OSCOMPORTNAME); OSCOMHANDLE1:=@OpenNTComPort("COM1"); OSCOMHANDLE1:=@C …
@OpenOSComPort
Öffnet das DEVICE mit dem OSCOMPORTNAME OSCOMPORTNAME und gibt einen OSCOMHANDLE darauf zurück. Beipiel: @OpenOSComPort(OSCOMPORTNAME); OSCOMHANDLE1:=@OpenOSComPort("COM1"); OSCOMHANDLE1:=@CloseOSComPort(OSCOMHANDLE1); D …
@OpenOSFile
Öffnet das OSFILE mit dem OSPATH OSPATH1 und gibt einen FILEHANDLE darauf zurück. Mit TEXT MODE2 kann der Modus des Öffnens bestimmt werden. MODE2: A=(Append) Öffnen zum Anhängen von Daten B=(Binary) Keine Umsetzung …
@OpenProfileNote
Öffnet ein Profile-Document in der DB mit dem DBHANDLE DBHANDLE1 und gibt den (geöffneten) NOTEHANDLE NOTEHANDLE3 auf dieses Profile-Document zurück. TEXT/TEXTLIST TEXT2/TEXTLIST2: Wird hier nur ein TEXT angegeben ist di …
@OpenQueue
Öffnet die Message-Queue mit dem Namen TEXT TEXTQUEUENAME. Im Erfolgsfall wird ein Queue-Handle zurückgegeben, andernfalls @ERROR.
@OpenView
Öffnet in der Datenbank mit dem DBHANDLE DBHANDLE1 eine(n) Ansicht/Folder mit dem Namen TEXT NAME2 (bzw. mit der NOTEID VIEWNOTEID) und liefert den VIEWHANDLE zurück. Im Parameter FN FNFLAGS3 können Optionen angegeben we …
@Password
Generiert aus dem TEXT TEXTPASSWORD1 einen Hash, der als TEXT zurückgegeben wird. Im Fehlerfall liefert @Password @Error zurückgegeben. FN FNHASHTYPE2: 1 liefert einen Hash wie @Password unter Notes zurück. (Version komp …
@Power
Berechnet FN/FNLIST FN1/FNLIST1 hoch FN/FNLIST FN2/FNLIST2. Dabei wird jedes Element von FNLIST2 auf das entsprechende Element von FNLIST1 angewandt. Sollte eine Liste kürzer sein, so wird deren letztes Element für alle …
@ProperCase
Liefert TEXT/TEXTLIST TEXT1/TEXTLIST1 in echter Groß-/Kleinschreibung zurück, d.h. der 1. Buchstabe groß, die folgenden klein.
@PrtVStack
Gibt den VStack mit dem Namen NAME1 aus (bei "" wird _PRCVSTACK - der lokale VStack der Funktion oder des Laufzeit-Context - genommen). Mit FN OPTIONS2 kann ein näheres Verhalten festgelegt werden und mit FN SIZE3 eine M …
@PushAndReplace
Diese @Function stellt einen speziellen One-Way-Replikator mit zusätzlicher Replace-Logik bereit. Sie ist aus einer kundenprojektspezifischen Anforderung entstanden und ist nicht als Ersatz für die klassische Domino-Repl …
@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 …
@PutQueue
Stellt die Message TEXT TEXTMESSAGE mit der Priorität FN FNPRIORITY in die Message-Queue mit dem Queue-Handle VSPECQUEUEHANDLE QUEUEHANDLE. Im Erfolgsfall wird TRUE zurückgegeben, andernfalls @ERROR. FN FNPRIORITY: 1 = …
@Rand
Derzeit nur unter NT verfügbar! Liefert eine pseudo-zufallszahl zwischen 0 und 32767.
@ReadACL
Diese @Function erzeugt eine in Memory Kopie der ACL der Datenbank mit dem angegebenen DBHANDLE DBHANDLE und gibt einen VSPECHACL (HACL) Handle auf diese Kopie zurück. Wenn der Handle VSPECHACL nicht mehr benötigt wird m …
@ReadAttachedFile
Liest aus dem File-Attachment mit dem OBJECTFILEHANDLE OBJECTFILEHANDLE1 einen Satz mit der Länge FN LENGTH3. Dieser Satz wird als Variable des Datentyp's, der in TEXT RETTYPE2 spezifiziert wird, zurückgegeben. Wird TEXT …
@ReadBuffer
Liest aus dem BINBUFFER mit dem BUFFERHANDLE BUFFERHANDLE1 einen Satz mit der Länge FN LENGTH3. Dieser Satz wird als Variable des Datentyp's, der in TEXT RETTYPE2 spezifiziert wird, zurückgegeben. RETTYPE2: A=TEXT B=BINA …
@ReadNTComPort
Lesen eines Wertes von dem COM-Port mit dem OSCOMHANDLE OSCOMHANDLE1 und zurückgeben als @Funktionsergebnis. Der gelesene Wert soll vom Typ TEXT RETTYPE2 sein. Gelesen wird entweder 1 Wert (für Ordinal-Typen) oder FN LEN …
@ReadOSComPort
RETTYPE2: A=TEXT B=BINARY (derzeit als RICHTEXT) N=NUMBER F=FLOAT L=FLOAT (konvertierter long) D=FLOAT (konvertiertes DWORD) T=TIMEDATE STATUS4: 0=OK 1=Read Timeout expired 2=TEXT limit reached (nur im TEXT Modus) 32768= …
@ReadOSFile
Liest aus dem OSFILE mit dem FILEHANDLE FILEHANDLE1 einen Satz mit der Länge FN LENGTH3. Dieser Satz wird als Variable des Datentyp's, der in TEXT RETTYPE2 spezifiziert wird, zurückgegeben. Wird TEXT/TEXTLIST TEXT3/TEXTL …
@ReadVarOSFile
Liest aus dem OSFILE mit dem FILEHANDLE FILEHANDLE1 eine Variable (die mit @WriteVarOSFile geschrieben wurde) und gibt diese zurück. Der Inhalt einer Variable, sowie deren Namen etc. kann direkt in ein File geschrieben u …
@RecalculateNote
NOTEHANDLE NOTEHANDLE1 Dokument, für das die Neuberechnung ausgeführt werden soll. NOTEHANDLE NOTEHANDLE2 Form-Design-Dokument, das die Formeln und Felder enthält. NF FLAGS3 0 Fehler melden 1 Bei Fehlern fortfahren Retur …
@ReleaseACL
Diese @Function gibt eine zuvor erzeugte VSPECHACL (HACL) wieder frei und setzt das darin enthaltene Handle auf NULL. Sie sollte aufgerufen werden, sobald die in Memory Kopie ACL nicht mehr benötigt wird. VSPECHACL HACL: …
@ReleaseClass
Es wird (werden) die Class(es) mit dem (den) Namen TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1 freigegeben. Returnwert: @Error -> Ein Fehler ist aufgetretten. TRUE -> Alle angeforderten Classes freigegeben. FALSE …
@ReleaseMutexSemaphore
Gibt die Mutex-Semaphore mit dem Mutex-Semaphore-Handle (MSH) MUTEXSEMAPHOREHANDLE wieder frei. Im Erfolgsfall wird @True zurückgegeben, andernfalls @ERROR. Eine Mutex-Semaphore kann nur von einem Task zu einem Zeitpunkt …
@RemoteConsole
Führt auf der Remote-Console des TEXT SERVER1 das Kommando TEXT COMMAND2 aus. Im Erfolgsfall wird als Ergebnis ein TEXT zurückgegeben, ansonsten ein @ERROR mit dem Fehlertext.
@RenameFolder
Diese @Function gibt dem Folder, in der DB mit dem DBHANDLE DBHANDLE1 und dem VIEWHANDLE VIEWHANDLEFOLDER2, den Namen TEXT NEWFOLDERNAME3. ReturnWert: Wurde die @Function erfolgreich durchgeführt wird TRUE zurückgegeben, …
@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 …
@ReorgList
Diese @Funktion bringt die Elemente einer Liste in eine neue Reihenfolge und gibt diese neue Liste zurück. TEXTLIST/FNLIST/TDLIST LIST1 ist die Liste deren Elemente in eine neue Reihenfolge gebracht werden sollen. FNLIST …
@Repeat
Wiederholt den Text in TEXT TEXT1 bzw. in jedem Element von TEXTLIST TEXTLIST1 bis die Anzahl FN COUNT2 erreicht ist und schneidet die entstandenen Texte evtl. nach FN LENGTH3 Stellen ab.
@Replace
Ersetzt in TEXT/TEXTLIST TEXT1/TEXTLIST1 alle Elemente TEXT/TEXTLIST TEXT2/TEXTLIST2 durch TEXT/TEXTLIST TEXT3/TEXTLIST3. Es wird also in TEXT2/TEXTLIST2 eine Liste von Textstücken angegeben, die durch Textstücke aus TEX …
@ReplaceSubString
Ersetzt in TEXT/TEXTLIST TEXT1/TEXTLIST1 die in TEXT/TEXTLIST TEXT2/TEXTLIST2 angegebenen Strings durch das korrespondierende Element aus TEXT/TEXTLIST TEXT3/TEXTLIST3. Der optionale Parameter FN FNCMPMODE bestimmt den S …
@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 …
@ReplicateWithFieldException
Deprecated! Siehe @ReplicateWithFieldProtection
@ReplicateWithFieldProtection
Repliziert die durch DBHANDLE1 referenzierte Datenbank mit der durch DBHANDLE2 referenzierten Datenbank. FNLIST3 enthält die Replikationsrechte. Das erste Element gibt die Rechte für die Replikation in der ersten Datenba …
@ReplicateWithFormula
Repliziert die durch DBHANDLE1 referenzierte Datenbank mit der durch DBHANDLE2 referenzierten Datenbank. Dabei werden nur die Dokumente repliziert, die der Notes-kompatiblen Selection Formula TEXT/TEXTLIST FORMULA3 entsp …
@ReplicateWithFormulaWithFieldException
Deprecated! Siehe @ReplicateWithFormulaWithFieldProtection
@ReplicateWithFormulaWithFieldProtection
Repliziert die durch DBHANDLE1 referenzierte Datenbank mit der durch DBHANDLE2 referenzierten Datenbank. Dabei werden nur die Dokumente repliziert, die der Notes-kompatiblen Selection Formula TEXT FORMULA3 entsprechen. 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 …
@RequestClass
Es wird (werden) die Class(es) mit dem (den) Namen TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1 angefordert. Returnwert: @Error -> Ein Fehler ist aufgetretten. TRUE -> Alle angeforderten Classes erhalten. FALSE -> …
@RequestMutexSemaphore
Verlangt und belegt (im Erfolgsfall) die Mutex-Semaphore mit dem Mutex-Semaphore-Handle (MSH) MUTEXSEMAPHOREHANDLE. Im Erfolgsfall wird @True zurückgegeben, andernfalls @ERROR. Wird FN FNTIMEOUT mit angegeben wird nach F …
@ResetVStack
Setzt alle Variablen auf dem VStack mit dem Namen TEXT NAME1 auf den Wert in VAR1 zurück.Wird die @Funktion in der Syntax ohne zweiten Parameter angegeben, werden die Variablen auf den Wert/Datentyp PV gesetzt. Sub-VStac …
@ResolveUserGroups
Diese @Function ermittelt für einen angegebenen Domino-Benutzer die vollständige Namensliste einschließlich aller direkten und indirekten Gruppenzugehörigkeiten. Die Funktion liefert eine TEXTLIST, deren erstes Element d …
@Reverse
Dreht die Reihenfolge der Buchstaben in TEXT TEXT1 oder in jedem Element von TEXTLIST TEXTLIST1 um.
@Right
Gibt den rechten Teil von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können FN COUNT2 Zeichen oder der rechts von TEXT TEXT2 stehende Text. Die Suche nach TEXT2 geschieht dabei von links nach rechts.
@RightBack
Gibt den rechten Teil von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können alle Zeichen bis auf FN COUNT2 verbleibende oder der rechts von TEXT TEXT2 stehende Text. Die Suche nach TEXT2 geschieht dabei von …
@RTAddButton
Fügt einen Button mit der Aufschrift TEXT TEXT1 und der CNFORMULA CNFORMULA4 an das RichText-Feld RT RT5 an. FNLIST STYLE2: 1. StyleDefinitionNumber 2. Schriftart 3. Größe 4. Optionen 5. Color 1. StyleDefinitio …
@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 …
@RTAddFileIcon
Fügt ein File-Icon im OS/2-Style an das RichText-Feld RT RT4 an. TEXT1: Zur Anzeige und zur Referenz innerhalb des Notes-Dokumentes bestimmter Name des File-Attachments, dieser Name muß eindeutig sein. TEXT2: Orginal Nam …