Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@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 …
@Increment
Erhöht FN FN1 um 1 und schreibt das Ergebnis direkt in FN1 zurück. HINWEIS: Diese @Funktion ist sehr schnell, aber sie liefert auch im Erfolgsfall kein Funktionsergebnis. Der Return Wert der @Function ist undefiniert !!! …
@IncrementViewPos
Erhöht den Zeiger in VIEWPOS VIEWPOS um 1 um auf das nächste Dokument in der Ansicht zu verweisen und schreibt das Ergebnis direkt in VIEWPOS VIEWPOS zurück. im Erfolgsfall liefert die @Function TRUE andernfalls @Error z …
@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.
@Integer
Schneidet die Nachkommastellen von FN/FNLIST FN1/FNLIST1 ab und gibt die ganzzahligen Werte zurück.
@IPAddressToText
Derzeit nur für Windows verfügbar!!! Die V4 IPAddresse FLOAT FLOATIPADDRESS wird zu TEXT konvertiert und zurückgegeben.
@IPCloseSocket
Derzeit nur für Windows verfügbar!!! Schließt die IP-Verbindung bzw. den Port IPSOCKET IPSOCKET1 und gibt einen geschlossenen IPSOCKET zurück.
@IPGetLocalAddress
Derzeit nur für Windows verfügbar!!! Gibt im Parameter FLOAT RETFLOATIPADDRESS die eigene lokale V4 IP-Addresse zurück. Return-Wert: @Error im Fehlerfall ansonsten der lokale Rechner-Name (als TEXT).
@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. …
@IPIsDataAvailable
Derzeit nur für Windows verfügbar!!! Liefert für eine IP-Verbindung IPSOCKET IPSOCKET1 zurück, ob Daten empfangen wurden. Rückgabe ist 0 oder 1. Sollte der IPSOCKET nicht mehr verfügbar sein (TCP) so ist der Rückgabewert …
@IPOpenReceiveSocket
Derzeit nur für Windows verfügbar!!! Öffnet einen Kommunikationspunkt (Port) für eingehende IP-Verbindungen zu dem Servernamen TEXT SERVER1, unter dem FN PORT2 und dem Protokoll TEXT PROCOTCOL3 und gibt einen IPSOCKET zu …
@IPOpenSendSocket
Derzeit nur für Windows verfügbar!!! Öffnet eine ausgehende IP-Verbindung zu Server TEXT SERVER1, FN PORT2 und dem Protokoll TEXT PROCOTCOL3 und gibt einen IPSOCKET zurück. Wenn der gewünschte Kommunikationspunkt (Port) …
@IPPing
Derzeit nur für Windows verfügbar!!! In TEXT TEXTRECHNERNAME wird der Rechner-Name oder die Rechner-V4-IPAddresse (als TEXT z.B. "172.16.1.100") des anzupingenden Rechner's angegeben. In FN FNTIMEOUTMS wird der TimeOut i …
@IPReceive
Derzeit nur für Windows verfügbar!!! Empfängt den TEXT RETTEXT2 über den geöffneten IPSOCKET IPSOCKET1. Der Rückgabewert der Funktion ist die Anzahl der empfangenen Bytes oder ein @ERROR-Wert. Der Timeout für diese Funkt …
@IPSend
Derzeit nur für Windows verfügbar!!! Sendet den RT/TEXT TEXT2/RT2 über den geöffneten IPSOCKET IPSOCKET1 und gibt die Anzahl der gesendeten Bytes zurück. Im Fehlerfall ist das Ergebnis ein @ERROR-Wert. FN FNFLAGS3: 0 (de …
@IPWaitForConnection
Derzeit nur für Windows verfügbar!!! Wartet auf das Öffnen einer eingehenden TCP-IP-Verbindung auf dem IPSOCKET IPSOCKET1 und kehrt andernfalls erst nach einem FN TIMEOUT3 oder 10 Sekunden dann aus dem Aufruf zurück. Ans …
@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 …
@Ln
Berechnet den natürlichen Logarithmus von FN/FNLIST FN1/FNLIST1. Beipiel: @Ln(FN1) FN1:=1; @Ln(FN1); ergibt 0
@Log
Berechnet den Logarithmus zur Basis 10 von FN/FNLIST FN1/FNLIST1. Beipiel: @Log(FN1) FN1:=1; @Log(FN1); ergibt 0
@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 !!!"
@MagicNumber
Gibt eine MagicNumber zu einem Wert FN FN1 zurück. Beipiel: @MagicNumber(FN1); Ret:=@MagicNumber(10); Es wird eine MagicNumber zur Zahl 10 berechnet (ist in diesem Fall 54373) und Ret zugewiesen.
@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. …
@Max
Liefert das Maximum von FN/FNLIST FN1/FNLIST1 und FN/FNLIST FN2/FNLIST2. Hierzu wird jedes Element von FNLIST1 mit dem entsprechenden Element von FNLIST2 verglichen. Sollte eine Liste kürzer sein, so wird deren letztes E …
@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 …
@MimePartAdd
Es wird ein neues MIMEPART-Segment an HUGEMIMEPART MIMEPART1 angefügt, das erweiterte MIMEPART-Feld wird wieder zurückgegeben. FN FNFLAGS2: In diesem Parameter werden die Flags für das neue Segment angegeben. Flag Hex …
@MimePartGet
Gibt die Informationen zu einem MIMEPART-Segment von HUGEMIMEPART MIMEPART1 zurück. FN FNSEGMENTNR2: Segment-Nummer des Segments, dessen Informationen angefordert werden (die Zählung beginnt mit 1). Return FN FNFLAGS3: I …
@Min
Liefert das Minimum von FN/FNLIST FN1/FNLIST1 und FN/FNLIST FN2/FNLIST2. Hierzu wird jedes Element von FNLIST1 mit dem entsprechenden Element von FNLIST2 verglichen. Sollte eine Liste kürzer sein, so wird deren letztes E …
@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 …
@Modified
Gibt den Zeitpunkt der letzten Änderung des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@Modulo
Berechnet den Rest der ganzzahligen Division FN/FNLIST FN1/FNLIST1 durch FN FN2. Kommastellen werden ignoriert und es werden keine negativen Reste zurückgegeben, daher sollten FN1/FNLIST1 und FN2 positiv und ganzzahlig s …
@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 …
@MoveFolder
Diese @Function verschiebt den Folder, in der DB mit dem DBHANDLE DBHANDLE1 und dem VIEWHANDLE VIEWHANDLEFOLDER2, unter den Folder mit dem VIEWHANDLE VIEWHANDLEPARENTFOLDER3. Die Folder müssen vom selben Typ (shared/priv …
@MySQLClose
Schließt einen VSPECMYSQL MySQLHandle. Der VSPECMYSQL MySQLHandle wird von @MySQLInit geliefert. Return: Im Erfolgsfall ein geschlosserner VSPECMYSQL MySQLHandle andernfalls @Error.
@MySQLConnect
Stellt eine Verbindung zum MySQL-Server her. Sollte nach @MySQLoptions aufgerufen werden. Der VSPECMYSQL MySQLHandle wird von @MySQLInit geliefert. TEXT Host (für lokal "" (NULLSTR)) TEXT User (kann u.U. auch "" (NULLSTR …
@MySQLCreatePreparedStatement
Erzeugt eine PreparedStatement Anfrage. Eine solche Anfrage stellt eine Art Template dar, das anschließend mit Daten zu einer vollständigen Anfrage ergänzt und ausgeführt werden kann. Diese Funktion ist für die mehrfache …
@MySQLFetchRow
Holt eine Zeile ab der aktuellen Position (siehe @MySQLSeekResult) eines gespeicherten Ergebnisses einer @MySQLQuery Anfrage. Der VSPECMYSQLRES MySQLResultHandle wird von @MySQLQuery geliefert. HINWEIS: Derzeit wird imme …