Engine Help Kategorie: Misc
Gefilterte Übersicht der Engine-Help-Dokumentation.
@GetTickCount
Gibt die vergangenen Millisekunden (ms) seit dem Systemstart als FN zurück. Die Auflösung ist vom System abhängig und liegt typischerweise zwischen 10 und 16 ms.
@GetVar
Gibt den Wert der Variablen mit dem Namen TEXT NAME1 zurück. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 angegeben werden. Hiermi …
@GetVarFromVar
Gibt die Variable TEXT/RT/FN/TD TEXT1/RT1/FN1/TD1 ab Position FN FN2 für FN FN3 Stellen zurück. In TEXT TYPE4 wird festgelegt, als welcher Datentyp der Rückgabewert zu interpretieren ist. RETTYPE4: A=TEXT B=Binär (RT) F= …
@GetVarWithFieldFlags
Gibt den Wert der Variablen mit dem Namen TEXT NAME1 zurück. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 angegeben werden. Hiermi …
@GetVStackPath2GFun
Liefert den Prefix für den Zugriffspfad einer Variable, die innerhalb der Thread-Kopie einer globalen Funktion gespeichert ist. Hiermit könnten z.B. Default-Werte für lokalen Parameter belegt werden. Nach Möglichkeit sol …
@HashPassword
Generiert aus dem TEXT TEXTPASSWORD1 einen Hash, der als TEXT zurückgegeben wird. Im Fehlerfall liefert @HashPassword @Error zurückgegeben. Diese @Function erzeugt einen Hash, der kompatibel ist zu einem mit Typ 2 (FN FN …
@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.
@Hour
Gibt die Stunden von TD/TDLIST TD1/TDLIST1 zurück. Wird die @Function mit dem Parameter TEXTOPTIONS aufgerufen, bestimmt dieser den Rückgabetyp. TEXT TEXTOPTIONS F=default (Rückgabe-Datentyp = FLOAT/FLOATLIST) A=Rückgabe …
@HugeTextList
Gibt eine Variable vom Typ HUGETEXTLIST mit 0 Elementen zurück.
@IDList
Gibt eine Variable vom Typ IDLIST mit 0 Elementen zurück.
@If
Wertet 1 bis 49 Bedingungen BOOL Condition1..49 aus und gibt als Ergebnis den Wert aus TrueValue1..49 zurück, der unmittelbar auf die erste zutreffende Bedingung Condition1..49 folgt. Wenn keine Bedingung Condition1..49 …
@Implode
Fügt TEXT/TEXTLIST TEXT1/TEXTLIST1 zu einem einzigen TEXT zusammen. Dabei wird zwischen allen zusammengefügten Elementen ein Leerzeichen eingefügt. Mit TEXT SEPTEXT2 kann alternativ ein anderer Zwischentext gewählt werde …
@IndexOf
Ermittelt ob im TEXT/BUFFERHANDLE TEXTINSTRING/BUFFERHANDLE der TEXT/ die Elemente der TEXTLIST TEXTSEARCH enthalten ist/sind und wenn ja, an welcher/welchen Position(en) sich dieser befindet/befinden. Die Position begin …
@InsertListElement
Fügt das Element FN/TD/TEXT ELEMENT3 in die Liste FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST LIST1 ein. Die Einfügeposition wird durch FN FN2 angegeben.
@IPHexDump2DecAdr
Wandelt IP-Adresse(n) in der HEXDump Notation (TEXT/TEXTLIST TEXT1/TEXTLIST1) in IP-Adresse(n) in der dezimalen Punkt-Notation um, und gibt diese zurück. HEXDump Notation: Eine IP-Adresse darf 7 oder 8 Stellen lang sein. …
@IsBitSet
Überprüft ob das Bit an der Position FN FN2 in FN FN1 gesetzt ist oder nicht. Wenn es gesetzt ist wird TRUE zurückgegeben, sonst FALSE. Die Position wird von hinten beginnend gezählt, und beginnt mit 1. Beispiele:@IsBitS …
@IsError
Prüft ob eine der Variablen VAR1-VAR99 einen Fehlerstatus enthält und gibt TRUE zurück, wenn dies der Fall ist, ansonsten FALSE. ACHTUNG: Diese @Funktion gibt TRUE zurück, wenn eine der Variablen VAR1-VAR99 vom Typ TEXT …
@IsMember
Gibt zurück, ob TEXT/TEXTLIST TEXT1/TEXTLIST1 vollständig in TEXT/TEXTLIST TEXT2/TEXTLIST2 enthalten ist. Wenn TEXTLIST1 keine Elemente enthält hängt das Ergebnis von dem Vorhandensein von Elementen in TEXTLIST2 ab: Ist …
@IsNotMember
Gibt 1 zurück, wenn TEXT/TEXTLIST TEXT1/TEXTLIST1 nicht vollständig in TEXT/TEXTLIST TEXT2/TEXTLIST2 enthalten ist, ansonsten 0. Wenn TEXTLIST1 keine Elemente enthält, hängt das Ergebnis von dem Vorhandensein von Element …
@JoinList
Implodiert TEXT/TEXTLIST TEXTLIST1 unter Berücksichtigung der FN/FNLIST LENGHTLIST2 und der Trennstringliste TEXT/TEXTLIST SEPERATORLIST3 zu einem TEXT. FN/FNLIST LENGHTLIST2: Ordnet jedem Element der TEXT/TEXTLIST TEXTL …
@Left
Gibt den linken Teil von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können FN COUNT2 Zeichen oder der links von TEXT TEXT2 stehende Text. Die Suche nach TEXT2 geschieht dabei von links nach rechts.
@LeftBack
Gibt den linken Teil von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können alle Zeichen bis auf FN COUNT2 verbleibende oder der links von TEXT TEXT2 stehende Text. Die Suche nach TEXT2 geschieht dabei von re …
@Length
Liefert als Ergebnis die Länge von VAR VAR1 bzw. die Längen der einzelnen Elemente von VARLIST VARLIST1 zurück. Es darf praktisch jeder Datentyp übergeben werden und der Speicherbedarf der jeweiligen Variable wird zurück …
@LogReport
Gibt den Inhalt der Variable VAR1 im API-Log und auf der Server-Konsole aus. Mit FN OPTIONS2 kann das nähere Verhalten der @Funktion bestimmt werden. FNLIST STYLE3 gibt die Schriftart,Optionen,Farbe und die Größe der @Lo …
@LowerCase
Liefert TEXT/TEXTLIST TEXT1/TEXTLIST1 in Kleinbuchstaben zurück. Beipiel: @LowerCase(TEXT1) TEXT1:="HeLLo woRLd !!!"; @LowerCase(TEXT1); ergibt "hello world !!!"
@MaxPos
Gibt die Position des ersten Auftretens des größten Elements in FN/FNLIST FN1/FNLIST1 zurück. Durch die Angabe von FN FROM2 und FN TO3 kann ein Bereich für die Suche festgelegt werden. Überschreitet dieser die Listengröß …
@Member
Gibt zurück, an welcher Stelle TEXT/FN TEXT1/FN1 in TEXT/TEXTLIST/IDLIST TEXT2/TEXTLIST2/IDLIST2 enthalten ist. Wenn TEXTLIST1/IDLIST1 keine Elemente enthält ist das Ergebnis 0. Wird @Member mit PositionList3 aufgerufen …
@Middle
Gibt FN LENGTH3 Zeichen aus dem Innerern von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können eine Startposition FN POSITION2 (beginnend von 0!) oder ein TEXT TEXT2 als Positionsangabe. Dabei ist zu beachte …
@MiddleBack
Gibt FN LENGTH3 Zeichen aus dem Innerern von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können eine Startposition FN POSITION2 (beginnend von 0!) oder ein TEXT TEXT2 als Positionsangabe. Dabei ist zu beachte …
@MinPos
Gibt die Position des ersten Auftretens des kleinsten Elements in FN/FNLIST FN1/FNLIST1 zurück. Durch die Angabe von FN FROM2 und FN TO3 kann ein Bereich für die Suche festgelegt werden. Überschreitet dieser die Listengr …
@Minute
Gibt die Minuten von TD/TDLIST TD1/TDLIST1 zurück. Wird die @Function mit dem Parameter TEXTOPTIONS aufgerufen, bestimmt dieser den Rückgabetyp. F=Wie ohne TEXTOPTIONS (Rückgabe-Datentyp = FLOAT/FLOATLIST) A=Rückgabe-Dat …
@Month
Gibt den Monat von TD/TDLIST TD1/TDLIST1 zurück. Wird die @Function mit dem Parameter TEXTOPTIONS aufgerufen, bestimmt dieser den Rückgabetyp. F=Wie ohne TEXTOPTIONS (Rückgabe-Datentyp = FLOAT/FLOATLIST) A=Rückgabe-Daten …
@Name
Im Prinzip analog zu Notes. Unterschied: Das KEYWORD muß in Anführungsstriche gesetzt werden: Also statt [CN] muß "[CN]" angegeben werden etc. KEYWORD: [O] [C] [OU1] [OU2] [OU3] [OU4] [CN] [Canonicalize] [Abbreviate] [To …
@Newline
Gibt einen Zeilenvorschub zurück, der in TEXT/TEXTLIST verwendet werden kann.
@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 …
@OpenQueue
Öffnet die Message-Queue mit dem Namen TEXT TEXTQUEUENAME. Im Erfolgsfall wird ein Queue-Handle zurückgegeben, andernfalls @ERROR.
@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 …
@ProperCase
Liefert TEXT/TEXTLIST TEXT1/TEXTLIST1 in echter Groß-/Kleinschreibung zurück, d.h. der 1. Buchstabe groß, die folgenden klein.
@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 = …
@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 …
@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 …
@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 …