Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@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 …
@TrimLeftAndRightQuote
Entfernt einen vorhandenen Anführungsstrich am Begin bzw. am Ende von TEXT TEXT1. Bei TEXTLIST TEXTLIST1 wird dies bei jedem Element durchgeführt. Anführungsstriche im TEXT TEXT1 bzw. in den Elementen von TEXTLIST TEXTLI …
@TrimList
Eliminiert leere Listenelemente aus TEXTLIST TEXTLIST1 und gibt eine TEXTLIST zurück. Bei Aufruf mit TEXT TEXT1 wird der TEXT unverändert zurückgegeben. Hinweis: Eine TEXTLIST aus n leeren Listenelementen (@BuildList(""; …
@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 …
@UNIDList
Gibt eine Variable vom Typ UNIDLIST mit 0 Elementen zurück.
@Unique
Eliminiert doppelte Einträge in einer TEXTLIST/FLOATLIST/IDLIST TEXTLIST1/FLOATLIST1/IDLIST1 und gibt diese bereinigte Liste zurück. Bei TEXT/FLOAT TEXT1/FLOAT1 wird dieser Wert unverändert wieder zurückgegeben. Bei IDLI …
@UniqueEven
Eliminiert, in der TEXTLIST TEXTLIST1, Einträge die in ungerader Anzahl vorkommen und gibt diese bereinigte Liste zurück. Die TEXTLIST TEXTLIST1 muß vorher mit @SortList sortiert worden sein. Bei TEXT TEXT1 wird eine NUL …
@UniqueUnEven
Eliminiert, in der TEXTLIST TEXTLIST1, Einträge die in gerader Anzahl vorkommen und gibt diese bereinigte Liste zurück. Die TEXTLIST TEXTLIST1 muß vorher mit @SortList sortiert worden sein. Bei TEXT TEXT1 wird dieser Wer …
@UpdateNote
Aktuallisiert das Dokument mit dem NOTEHANDLE NOTEHANDLE1 und liefert den NOTEHANDLE wieder zurück. Mit FN MODE2 kann ein näheres Verhalten bestimmt werden. MODE2: 0 = Keine Änderungen speichern. 1 = Änderungen speichern …
@UpdateView
Aktualisiert die Ansicht mit dem VIEWHANDLE VIEWHANDLE1 und liefert den VIEWHANDLE1 wieder zurück.
@UpperCase
Liefert TEXT/TEXTLIST TEXT1/TEXTLIST1 in Großbuchstaben zurück. Beipiel: @UpperCase(TEXT1) TEXT1:="HeLLo woRLd !!!"; @UpperCase(TEXT1); ergibt "HELLO WORLD !!!"
@VerifyNoteSignature
Prüft ob das Dokument mit dem NOTEHANDLE NOTEHANDLE1 unterzeichnet ist und ob die Unterzeichnung noch gültig ist. Konnte eine Unterzeichnung positiv bestätigt werden (certified key im Adreßbuch) wird TRUE zurückgegeben, …
@VerifyPassword
Prüft, ob das Passwort TEXT TEXTPASSWORD1 zu dem Hash (siehe @Password) TEXT TEXTHASH2 passt, oder nicht. Im Erfolgsfall wird TRUE zurückgegeben, andernfalls FALSE.
@ViewPos
Gibt die Informationen zu der VIEWPOS VIEWPOS zurück. Der Return-Wert der @Function liefert die Anzahl der gefundenen Dokument (z.B. durch die @Function @FindDocumentsByKey) zurück. Im optionalen Parameter FNLIST FNPOSLI …
@WaitNTComPortEvent
Nur für Engine unter Windows! Auf einen bestimmten Event warten, der auf dem COM-Port mit OSCOMHANDLE OSCOMHANDLE1 auftritt. Wenn FN MASK2 nicht angegeben wird, dann gilt die aktuelle Einstellung. Ansonsten wird die gült …
@Weekday
Gibt den Wochentag von TD/TDLIST TD1/TDLIST1 als NUMBER zwischen 1 (Sonntag) und 7 (Samstag) zurück.
@Word
Gibt das Wort an der Position FN/FNLIST POSITION3 von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück, wobei in TEXT/TEXTLIST TEXT2/TEXTLIST2 ein Trenntext festgelegt wird, der die Worte voneinander trennt. Sowohl von TEXTLIST2 als …
@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 …
@WriteNTComPort
Nur für Engine unter Windows! Ausgeben des Inhalts einer Variable vom Typ TEXT, FN oder TD auf einem zuvor geöffneten COM-Port.
@WriteOSComPort
Beispiel: @WriteOSComPort(OSCOMHANDLE1;TEXT2) OSCOMHANDLE1:=@OpenOSComPort("COM1"); TEXT2:="TestText"; @WriteOSComPort(OSCOMHANDLE1;TEXT2); FILEHANDLE1:=@CloseOSComPort(OSCOMHANDLE1); Öffnet einen Com-Port, schreibt den …
@WriteOSFile
Schreibt den Inhalt von TEXT/FN/TD TEXT2/FN2/TD2 in das OSFILE mit dem FILEHANDLE FILEHANDLE1. War die Operation erfolgreich wird 1 (NUMBER) zurückgegeben. Der optionale Parameter TEXT TEXTWRITETYPE3 spezifiziert bei Zah …
@WriteVarOSFile
Schreibt die gesamte Repräsentation der Variable VAR mit allen dazugehörenden Metadaten binär in das OSFILE mit dem FILEHANDLE FILEHANDLE1. War die Operation erfolgreich wird 1 (NUMBER) zurückgegeben. Eine so geschrieben …
@Year
Gibt das Jahr von TD/TDLIST TD1/TDLIST1 zurück. Wird die @Function mit dem Parameter TEXT TEXTOPTIONS aufgerufen, bestimmt dieser den Rückgabetyp. F=Wie ohne TEXT TEXTOPTIONS (Rückgabe-Datentyp = FLOAT/FLOATLIST) A=Rückg …