Engine Help Kategorie: System
Gefilterte Übersicht der Engine-Help-Dokumentation.
@HexDumpToBin
@HexDumpToBin wandelt den Hex-Stream-Dump in TEXT/BINBUFFER VAR1 in einen binären Buffer um. Whitespace wird dabei ignoriert! Über TEXT TEXTRETTYPE2 kann bestimmt werden, ob die zurück gegebenen Binärdaten als RT oder al …
@HookUpdateFields
Mit dieser @Funktion werden, durch das Engine-Script der gloablen HOOK-Funktion, geänderte Felder, des Dokuments mit dem NOTEHANDLE NOTEHANDLE1, zurück in das Dokument transferiert.
@MainDatabase
Ohne Parameter liefert @MainDatabase den DBHANDLE auf die aktuelle Haupt-Datenbank (AEF DATABASE Statement). Mit Parametern arbeitet @MainDatabase wie @OpenDB, aber die geöffnete Datenbank wird zur neuen Haupt-Datenbank. …
@Now
Liefert den aktuellen Zeit-Datums-Wert. Wenn die @Function mit dem optionalem Parameter FN FN = 1 aufgerufen wird, wird die System-Zeit nicht die Domino-Server-Zeit (diese kann sich unterscheiden!) zurückgegeben.
@NTRegistryDeleteKey
Löscht den SUBKEY mit dem Namen TEXT TEXTSUBKEYNAME2 unter dem KeyPfad TEXT TEXTKEYPATH1 mit allen darin befindlichen Values. ReturnWert: Im Erfolgsfall TRUE, andernfalls @ERROR.
@NTRegistryDeleteValue
Löscht den Wert (Value) mit dem Namen TEXT TEXTVALUENAME2 unter dem KeyPfad TEXT TEXTKEYPATH1. ReturnWert: Im Erfolgsfall TRUE, andernfalls @ERROR.
@NTRegistryGetValue
Holt den Inhalt des Wert's (Value) mit dem Namen TEXT TEXTVALUENAME2, unter dem KeyPfad TEXT TEXTKEYPATH1, und gibt diesen in RETVALUE3 zurück. Der DataType von RETVALUE3 hängt vom Datentyp der Registry-Value ab. Folgend …
@NTRegistryScanSubKeys
Holt die unter dem KeyPath TEXT TEXTKEYPATH1 befindlichen SubKeys und gibt diese als HUGETEXTLIST zurück. ReturnWert: Im Erfolgsfall HUGETEXTLIST, andernfalls @ERROR.
@NTRegistryScanValues
Holt die unter dem KeyPath TEXT TEXTKEYPATH1 befindlichen Werte (Values) und gibt deren Namen als HUGETEXTLIST zurück. ReturnWert: Im Erfolgsfall HUGETEXTLIST, andernfalls @ERROR.
@NTRegistrySetValue
Setzt den Inhalt des Wert's (Value) mit dem Namen TEXT TEXTVALUENAME2, unter dem KeyPfad TEXT TEXTKEYPATH1, auf den Inhalt der Variable VALUE3. Folgende Datentypen werden unterstütz (für VALUE3): TEXT TEXTLIST NUMBER (wi …
@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 …
@Rand
Derzeit nur unter NT verfügbar! Liefert eine pseudo-zufallszahl zwischen 0 und 32767.
@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 …
@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 …
@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 …
@SaveMain
Nur innerhalb IDF: Negiert die generelle Aussage zum Abspeichern des MAIN Dokumentes. Siehe IDF-Dokument SECTION SYSTEM.
@ScanVStack
Gibt alle Variablen auf dem VStack mit dem Namen TEXT NAME1 als TEXTLIST zurück. Variablen der Daten-Typen PV und UA werden dabei nicht berücksichtigt. Wenn für NAME1 nur "" angegeben wird, dann werden die Variablen von …
@SetFieldFlags
Setzt die Field Flags FN2 für Notes in eine Variable. Werden einer Variable nicht explizit mit @SetFieldFlags Flags zugewiesen, werden die default Werte angenommen. Wurden jedoch Flags zugewiesen gelten immer diese. Fiel …
@SetLocalServerTime
Setzt die Domino-Server Zeit. ACHTUNG: Das Verändern der Notes-Server-Zeit kann zu Nebeneffekten führen. Im Besonderen, wenn die Zeit in die Vergangenheit zurückgedreht wird. (Zum Beispiel können Dokumente verschwinden b …
@SetLogDocField
Setzt ein Feld mit dem Namen TEXT TEXT1 und dem Inhalt TEXT/TEXTLIST/FN/FNLIST/TD/TDLIST TEXT2/TEXTLIST2/FN2/FNLIST2/TD2/TDLIST2 in das aktuelle APILog-Document.
@SetPosBuffer
Setzt die Position in dem BINBUFFER mit dem BUFFERHANDLE BUFFERHANDLE1 auf die in FN POSITION2 angegebene Position (in Byte) unter Berücksichtigung des Modus TEXT MODE3. MODE3: S=Vom Start des BINBUFFER an gerechnet C=Au …
@SetTaskTimeout
Aktiviert die Task Timeout Überwachung, für den Task, der @SetTaskTimeout aufruft. FN FN1 gibt die Zeit in Sekunden an, die der Task ab dem Aufruf der @Function noch benötigen darf bis zum nächsten Aufruf von @SetTaskTim …
@SetVar
Setzt den Wert der Variable(n) mit dem(den) Namen TEXT/TEXTLIST NAME1 auf den Wert VAR3. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GRO …
@SetVarFieldFlags
Setzt die Notes-Feld-Flags für das in TEXT NAME1 angegebene Feld auf den Wert FN FN1. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 …
@SetVarInVar
Setzt in die Variable VARDEST1 an der Position FN POSITION2 von der Variablen VARSOURCE2 ab der Position FN POSITION4 FN LENGTH Byte ein und gibt das Ergebnis zurück. Mit TEXT MODE6 kann die Art des Einsetzens näherer be …
@SetVarWithFieldFlags
Setzt den Wert der Variable(n) mit dem(den) Namen TEXT/TEXTLIST NAME1 auf den Wert VAR3. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GRO …
@Shell
Führt die OS2-Shell-Kommandos in TEXT COMMAND1 aus und gibt den Return-Status zurück.
@Sleep
Hält die Bearbeitung des aktuellen Scripts um FN COUNT1 1/10 Sekunden an. Da hierbei ein Idle-Wait durchgeführt wird, der den Prozessor nicht belegt, ist diese Funktion einer leeren Zählschleife in jedem Fall vorzuziehen …
@SleepMS
Hält die Bearbeitung des aktuellen Scripts um FN COUNT1 Millisekunden an. Da hierbei ein Idle-Wait durchgeführt wird, der den Prozessor nicht belegt, ist diese Funktion einer leeren Zählschleife in jedem Fall vorzuziehen …
@SwitchLogDoc
Nach dem Aufruf dieser @Function wird das Log in einem neuen Folge-APILOG-Dokument fortgesetzt. Beispiel @SwitchLogDoc: @LogReport("document 1"); @SwitchLogDoc; @LogReport("document 2"); Die Zeile "document 1" wird im er …
@TaskShouldStop
Liefert als Return-Wert eine 1, wenn die Engine beenden soll, weil z.B. der Domino-Server heruntergefahren wird. Diese Funktion kann als Abbruchbedingung für sehr lange Schleifen bzw. Endlosschleifen benutzt werden, die …
@Today
Gibt das aktuelle Tagesdatum zurück.
@Tomorrow
Gibt das Tagesdatum des nächsten Tages zurück.
@Unavailable
Löscht eine Variable in einem Dokument oder einer VARGROUP, wenn sie als rechter Wert einer Zuweisung verwendet wird, durch Rückgabe des Wertes UV Unavailable.
@Undefine
Löscht einen definierten "Begriff" der zur bedingten Compilierung genutzt werden kann. Im Unterschied zum Keyword UNDEFINE wird @Undefine zur Ausführungszeit (und nur wenn dieser @Undefine ausgeführt wird) wirksam. TEXT1 …
@WriteBuffer
Schreibt den Inhalt einer Variable ab der aktuellen Position (siehe @GetPosBuffer/@SetPosBuffer) in den BINBUFFER mit dem BUFFERHANDLE BUFFERHANDLE1. Derzeit werden für VAR2 folgende Datentypen unterstützt: TEXT TEXTLIST …
@Yesterday
Gibt das Tagesdatum des vorherigen Tages zurück.
TELL Engine Commands
Auf der Server-Console können der Engine bzw. einzelnen Engine-Tasks mit dem Kommando TELL Anweisungen erteilt werden. Kommando: Bedeutung: do compact Startet manuell eine API-Log-Kompaktierung. stop TASKID Signali …