Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@HttpExtractFields
Die http POST Fields in TEXT TEXT1 werden als Engine-Variable auf den VStack TEXT VSTACKPATH2 abgelegt. Im Erfolgs-Fall wird TRUE zurückgegeben, andernfalls @ERROR.
@HTTPGet
Liefert den HTML-Code einer WWW-Seite als TEXT zurück. Neben TEXT SERVER1 und TEXT PAGE2 kann optional eine Portnummer FN PORT3 bestimmt werden. Ohne Angabe wird standardmäßig 80 verwendet. Der default Timeout für diese …
@HTTPSGet
Liefert den HTML-Code einer WWW-Seite als TEXT zurück. Neben TEXT SERVER1 und TEXT PAGE2 kann optional eine Portnummer FN/TEXT PORT3 bestimmt werden. Ohne Angabe wird standardmäßig 443 (https) verwendet. FN FNTIMEOUT4 is …
@HugeMimePart
Gibt eine Variable vom Typ HUGEMIMEPART (HMP) mit 0 Elementen zurück.
@HugeRFC822
Gibt eine Variable vom Typ VHUGERFC822 (HRF8) mit 0 Elementen zurück.
@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 …
@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
Die V4 IPAddresse FLOAT FLOATIPADDRESS wird zu TEXT konvertiert und zurückgegeben. Derzeit nur für Windows verfügbar!!!
@IPCloseSocket
Schließt die IP-Verbindung bzw. den Port IPSOCKET IPSOCKET1 und gibt einen geschlossenen IPSOCKET zurück. Derzeit nur für Windows verfügbar!!!
@IPGetLocalAddress
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). Derzeit nur für Windows verfügbar!!!
@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
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 ein @ERROR. Derzeit nur für Windows …
@IPOpenReceiveSocket
Ö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 zurück. Der erste Parameter kann auch l …
@IPOpenSendSocket
Ö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) nicht verfügbar ist, so ist das Ergeb …
@IPPing
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 in Millisekunden angegeben (gilt für j …
@IPReceive
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 Funktion beträgt 10 Sekunden oder FN TIMEO …
@IPSend
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 (default) - 1 Flush sendbuffer Derzeit n …
@IPWaitForConnection
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. Anschließend können über @IPSend und @IP …
@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 …
@JsonAdd
Diese @Function fügt einem bestehenden JSON-Object oder JSON-Array einen neuen Wert hinzu. Das Verhalten und die Bedeutung der optionalen Parameter hängen davon ab, ob HJSON auf ein JSON-Object oder ein JSON-Array verwei …
@JsonCreate
Die @Function erzeugt eine neue leere JSON-Struktur und gibt ein VSPECHJSON (HJS) Handle zurück. Wird die Funktion ohne Parameter aufgerufen, wird standardmäßig ein JSON-Object erzeugt. Wird als optionaler Parameter JSON …
@JsonGet
Diese @Function liest einen Wert aus einem bestehenden JSON-Object oder JSON-Array und wandelt ihn, soweit möglich, in einen entsprechenden Engine-Datentyp um. Das Verhalten des zweiten Parameters hängt davon ab, ob HJSO …
@JsonGetKeys
Diese @Function liefert alle Keys eines JSON-Objects als TEXTLIST zurück. HJSON muss ein gültiges VSPECHJSON (HJS) Handle enthalten, das auf ein JSON-Object verweist. JSON-Arrays werden von dieser Funktion nicht unterstü …
@JsonParse
Diese @Function analysiert eine JSON-Textdarstellung und erzeugt daraus eine JSON-Struktur. Als Eingabe kann entweder ein TEXT oder ein VSPECBINBUFFER übergeben werden. Der Inhalt wird als JSON interpretiert und muss in …
@JsonRelease
Diese @Function gibt ein zuvor erzeugtes VSPECHJSON (HJS) Handle wieder frei. Die Funktion reduziert den Referenzzähler des durch HJSON referenzierten JSON-Objects oder JSON-Arrays. Erreicht der Referenzzähler den Wert 0 …
@JsonRemove
Diese @Function entfernt einen Wert aus einem bestehenden JSON-Object oder JSON-Array. Bei einem JSON-Object muss der zweite Parameter ein TEXT KEY sein. Der dem angegebenen Key zugeordnete Wert wird aus dem Object entfe …
@JsonSerialize
Diese @Function serialisiert ein JSON-Object oder JSON-Array und gibt dessen vollständige JSON-Textdarstellung zurück. Die erzeugte JSON-Darstellung wird im kompakten Format ohne zusätzliche Einrückungen oder Zeilenumbrü …
@JsonSize
Diese @Function liefert die Anzahl der Elemente eines JSON-Arrays beziehungsweise die Anzahl der Keys eines JSON-Objects zurück. Bei einem JSON-Array entspricht der Return-Wert der Anzahl der enthaltenen Array-Elemente. …
@JsonType
Diese @Function ermittelt den Typ einer JSON-Struktur. HJSON muss ein gültiges VSPECHJSON (HJS) Handle enthalten, das auf ein JSON-Object oder JSON-Array verweist. Als Return-Wert liefert die @Function einen TEXT mit ein …
@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 …
