Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@SetOSComPortLineInfo
Setzt die PortInfo zu einem OSCOMPORT (Device). FNDATA1: Data Bits 7 oder 8 FNPARITY1: Parity Bits (unklar) 0 =1 Bit 2 =2 Bit ??? FNSTOP1: Stop Bits (unklar) 0 =1 Bit 2 =2 Bit ??? FNTBREAK1 (TransBreak): Unklar ??? Beisp …
@SetOSComPortSpeed
Setzt die an dem OSCOMPORT verwendete Baud-Rate.
@SetPosAttachedFile
Setzt die Position in dem File-Attachment mit dem OBJECTFILEHANDLE OBJECTFILEHANDLE1 auf die in FN POSITION2 angegebene Position (in Byte) unter Berücksichtigung des Modus TEXT MODE3. Die neue Position wird zurückgegeben …
@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 …
@SetPosOSFile
Setzt die Position in dem OSFILE mit dem FILEHANDLE FILEHANDLE1 auf die in FN POSITION2 angegebene Position (in Byte) unter Berücksichtigung des Modus TEXT MODE3. MODE3: S=Vom Start des OSFILE an gerechnet C=Augenblickli …
@SetProfileField
Setzt den Inhalt des Profile-Feld's, mit dem Namen TEXT TEXTFIELDNAME, für den Benutzer mit dem Namen TEXT TEXTUSERNAME (kann auch "" sein), unter Berücksichtigung der Profile-Form mit dem Namen TEXT TEXTPROFILEFORMNAME …
@SetSchedListEntry
Setzt die Daten für einen bestimmten Eintrag FN POSITION2 der SCHEDLIST SCHEDLIST1. In UID UID3 wird die UID des documents übergeben auf das sich dieser Eintrag bezieht. In TDLIST TDLRANGE4 wird die Zeitspanne dieses Ein …
@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.
@ShiftList
Verschiebt die FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1 in der Richtung FN DIRECTION3, setzt an die freigewordene Position FN/TEXT/TD FN2/TEXT2/TD2 und entfernt das Element am anderen End …
@Sin
Berechnet den Sinus von FN/FNLIST FN1/FNLIST1.
@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 …
@SortList
Sortiert den/die TEXT/TEXTLIST TEXT1/TEXTLIST1 und gibt diese sortierte Liste zurück. Optional kann eine Reorganisationsliste NUMBERLIST SEQUENCE1 zurückgegeben werden. Diese kann mit @ReorgList dazu benutzt werden, um a …
@Soundex
Gibt einen numerischen Code für TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück, der einen homophonen (gleichklingenden) Vergleich ermöglicht. Sie wird hauptsächlich im Adressbuch gebraucht.
@Sqrt
Berechnet die Quadratwurzel von FN/FNLIST FN1/FNLIST1.
@StartOSComPortTransmit
Started die Pufferung und Übertragung (mit Handshake etc) für den COMPORT mit dem OSCOMHANDLE OSCOMHANDLE1.
@StopOSComPortTransmit
Stoppt die Pufferung und Übertragung (mit Handshake etc) für den COMPORT mit dem OSCOMHANDLE OSCOMHANDLE1.
@StringExceptions
Die StringExceptions (Siehe Texte StringExceptions) die der Compiler bei statischen Texten ausführt werden durch @StringExceptions auch auf den übergebenen TEXT TEXT1 ausgeführt. Beispiel @StringExceptions(TEXT1): Text:= …
@Subset
Gibt eine Teilliste von FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/IDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/IDLIST1 zurück. Ist FN COUNT2 positiv, so werden die ersten COUNT2 Elemente zurückgegeben, ist COUNT2 negativ, dann …
@SumOfList
Gibt die Summe der FN/FNLIST FNLIST1/FN2 zurück. Mit FN FROM2 und FN TO3 kann ein Bereich für die Summation festgelegt werden, es wird dann von Element FROM2 bis Element TO3 aufsummiert.
@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 …
@Tan
Berechnet den Tangens von FN/FNLIST FN1/FNLIST1.
@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 …
@Text
Wandelt FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/UIDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/UIDLIST1 in einen TEXT/TEXTLIST um und gibt ihn zurück. (Bei UIDLIST ist der Rückgabe-Datentyp immer TEXTLIST) HINWEIS: @Text in d …
@TextToDigits
Wandelt die ASCII Zeichen von TEXT/TEXTLIST TEXT1/TEXTLIST1 in die dazugehörigen ASCII-CHAR Werte um und gibt sie in Form eines/einer TEXT/TEXTLIST wieder zurück. In OPTIONS1 wird angegeben in welchem Zahlensystem die AS …
@TextToNumber
Wandelt den/die TEXT/TEXTLIST TEXT1/TEXTLIST1 in eine(n) FLOAT/FLOATLIST und gibt diese(n) zurück. Mit FN MODE2 kann der Modus der Umwandlung bestimmt werden, fehlt er wird er mit Null angenommen. HINWEIS: @TextToNumber …
@TextToTime
Wandelt den Text TEXT/TEXTLIST TEXT1/TEXTLIST1 in einen Zeit-Datums-Wert TD/TDLIST um. TEXT TEXTOPTIONS: Wird hier "*" angegeben, werden die Texte im TD-Hex-Dump-Format (z.B. "C1255DF0:004B73DC" (entspricht "14.09.1992 1 …
@TextToTimePair
Wandelt den Text TEXT TEXT1 in einen Zeit-Datums-Paar-Wert TDLIST um. Als Trennzeichen für das Zeit-Datums-Paar ist ein "-" zu verwenden. Als Trennzeichen zwischen einzelnen Datumskomponenten ist kein "/" bzw. "-" zu ver …
@TextToUID
Wandelt den Text TEXT/TEXTLIST TEXT1/TEXTLIST1 in eine UIDList um. TEXT1 bzw. die einzelnen Elemente von TEXTLIST1 müssen eine Länge von 32 Zeichen haben.
@Time
Setzt aus den Einzelwerten FN YEAR1/MONTH2/DAY3/HOUR4/MINUTE5/SECOND6 einen Zeit-Datums-Wert TD zusammen und gibt diesen zurück. HINWEIS: @Time in der Engine unterscheidet sich geringfügig von der Notes-@Funktion @Time! …
@Today
Gibt das aktuelle Tagesdatum zurück.
@Tomorrow
Gibt das Tagesdatum des nächsten Tages zurück.
@Trace
Schaltet den Trace-Modus entsprechend FN STATE1 an (1) oder aus (0). Damit wird festgelegt, ob alle Fehler (1) oder nur schwerwiegende Fehler (0) in das Log-File geschrieben werden. @
@TransferNoteHandle
Bildet den externen NOTEHANDLE NOTEHANDLE1 auf den NOTEHANDLE NOTEHANDLE2 ab und transferiert ihn dabei in den aktuellen Kontext. Der NOTEHANDLE NOTEHANDLE2 wird zurückgegeben. @TransferNoteHandle ist vor allem für GLOBA …
@Translate
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird wie durch FN FNCHARSETS definiert umgesetzt. Dies ist die direkte Umsetzung durch die entsprechende Funktion in der Domino-API. FN FNCHARSETS: OS_TRANSLATE_NATIVE_TO_LMBCS 0 /* Tra …
@TranslateASCIIToEBCDIC
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom ASCII Character Set in das EBCDIC Character Set umgesetzt.
@TranslateASCIIToISO88591
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom ASCII Character Set in das ISO88591 Character Set umgesetzt.
@TranslateASCIIToWinANSI
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom ASCII Character Set in das WinANSI Character Set umgesetzt.
@TranslateEBCDICToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom EBCDIC Character Set in das ASCII Character Set umgesetzt.
@TranslateISO88591ToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom ISO88591 Character Set in das ASCII Character Set umgesetzt.
@TranslateURLEncodingToUTF8
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird aus der URL-encoding-Darstellung in das UTF8 Character Set umgesetzt.
@TranslateUTF8ToHtmlEntities
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom UTF8 Character Set in HTML-Entities umgesetzt.
@TranslateUTF8ToUrlEncoding
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom UTF8 Character Set in die URL-encoding-Darstellung umgesetzt. Im optionalen Parameter FN FNOPTIONS1 kann die Umsetzung beeinflusst werden: FN FNOPTIONS1: 0 Ein + zeichen wird zu %2B …
@TranslateWinANSIToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 wird vom WinANSI Character Set in das ASCII Character Set umgesetzt.
@Trim
Entfernt führende, nachfolgende und überflüssige Leerzeichen aus TEXT/TEXTLIST TEXT1/TEXTLIST1 und gibt TEXT/TEXTLIST zurück. Leere Listenelemente werden nicht entfernt. HINWEIS: @Trim in der Engine unterscheidet sich ge …