Engine Help: Function
Filtered overview of the Engine Help documentation.
@If
Evaluates 1 to 49 conditions BOOL Condition1..49 and returns as the result the value from TrueValue1..49 that immediately follows the first matching condition Condition1..49 . If no condition Condition1..49 matches, the …
@Implode
Joins TEXT/TEXTLIST TEXT1/TEXTLIST1 into a single TEXT . A space is inserted between all joined elements. With TEXT SEPTEXT2, a different separator text can be selected instead.
@Increment
Increments FN FN1 by 1 and writes the result directly back to FN1. NOTE: This @Function is very fast, but it does not return a function result even on success. The return value of the @Function is undefined!!! The expres …
@IncrementViewPos
Increments the pointer in VIEWPOS VIEWPOS by 1 to point to the next document in the view and writes the result directly back to VIEWPOS VIEWPOS. On success this @Function returns TRUE otherwise @Error. FN FNLEVEL (Option …
@IndexOf
Determines whether, in TEXT/BUFFERHANDLE TEXTINSTRING/BUFFERHANDLE der TEXT/the elements of TEXTLIST TEXTSEARCH is/are contained and, if so, at which position(s) it/they are located. The position starts at 0. If the TEXT …
@InsertListElement
Inserts the element FN/TD/TEXT ELEMENT3 into the list FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST LIST1 at the position specified by FN FN2.
@Integer
Truncates the decimal places of FN/FNLIST FN1/FNLIST1 ab und gibt die ganzzahligen Werte.
@IPAddressToText
Currently available for Windows only!!! The V4 IP address FLOAT FLOATIPADDRESS is converted to TEXT and returned.
@IPCloseSocket
Currently available for Windows only!!! Closes the IP connection or port IPSOCKET IPSOCKET1 and returns a closed IPSOCKET.
@IPGetLocalAddress
Currently available for Windows only!!! The local V4 IP address is returned in FLOAT RETFLOATIPADDRESS. Return value: @Error in case of an error; otherwise the local host name (as TEXT).
@IPHexDump2DecAdr
Converts V4 IP address(es) in HEX dump notation (TEXT/TEXTLIST TEXT1/TEXTLIST1) into IP address(es) in decimal dotted notation and returns them. HEXDump Notation: An IP address may be 7 or 8 characters long. If it has 7 …
@IPIsDataAvailable
Currently available for Windows only!!! For an IP connection, returns IPSOCKET IPSOCKET1 whether data has been received. The return value is 0 or 1. If the IPSOCKET is no longer available (TCP), the return value is an @E …
@IPOpenReceiveSocket
Currently available for Windows only!!! Opens a communication endpoint (port) for incoming IP connections on the server name TEXT SERVER1, unter dem FN PORT2 und dem Protokoll TEXT PROCOTCOL3 und gibt einen IPSOCKET. The …
@IPOpenSendSocket
Currently available for Windows only!!! Opens an outgoing IP connection to server TEXT SERVER1, FN PORT2 und dem Protokoll TEXT PROCOTCOL3 und gibt einen IPSOCKET. If the requested communication endpoint (port) is not av …
@IPPing
Currently available for Windows only!!! In TEXT TEXTRECHNERNAME specifies the host name or host V4 IP address (as TEXT for example "172.16.1.100") of the host to be pinged. In FN FNTIMEOUTMS specifies the timeout in mill …
@IPReceive
Currently available for Windows only!!! Receives the TEXT RETTEXT2 via the opened IPSOCKET IPSOCKET1. The return value of the function is the number of received bytes or an @ERROR-Wert. The timeout for this function is 1 …
@IPSend
Currently available for Windows only!!! Sends the RT/TEXT TEXT2/RT2 via the opened IPSOCKET IPSOCKET1 and returns the number of bytes sent. In case of an error, the result is an @ERROR-Wert. FN FNFLAGS3: 0 (default) - 1 …
@IPWaitForConnection
Currently available for Windows only!!! Waits for an incoming TCP/IP connection to be opened on IPSOCKET IPSOCKET1 and otherwise returns from the call only after FN TIMEOUT3 or 10 seconds. After that, data can be exchang …
@IsBitSet
Checks whether the bit at position FN FN2 in FN FN1 is set or not. If it is set, TRUE is returned; otherwise FALSE. The position is counted from the back and starts with 1. Examples: @IsBitSet(FN1;FN2); X:=1; Ret:=@IsBit …
@IsError
Checks whether any of the variables VAR1-VAR99 contains an error status and returns TRUE if this is the case; otherwise FALSE. IMPORTANT: This @Function returns TRUE if one of the variables VAR1-VAR99 are of Type TEXT st …
@IsMember
Returns whether TEXT/TEXTLIST TEXT1/TEXTLIST1 is completely contained in TEXT/TEXTLIST TEXT2/TEXTLIST2. If TEXTLIST1 contains no elements, the result depends on whether TEXTLIST2 contains any elements: if TEXTLIST2 is em …
@IsNotMember
Returns 1 if TEXT/TEXTLIST TEXT1/TEXTLIST1 is not completely contained in TEXT/TEXTLIST TEXT2/TEXTLIST2; otherwise returns 0. If TEXTLIST1 contains no elements, the result depends on whether TEXTLIST2 contains any elemen …
@JoinList
Implodes TEXT/TEXTLIST TEXTLIST1 taking into account FN/FNLIST LENGHTLIST2 and the separator string list TEXT/TEXTLIST SEPERATORLIST3 zu einem TEXT. FN/FNLIST LENGHTLIST2: Assigns a length to each element of TEXT/TEXTLIS …
@Left
Returns the left part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selected part can be FN COUNT2 characters or the text to the left of TEXT TEXT2. The search for TEXT2 is performed from left to right.
@LeftBack
Returns the left part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selected part can be all characters except for FN COUNT2 remaining characters, or the text to the left of TEXT TEXT2. The search for TEXT2 is performed from rig …
@Length
Returns the length of VAR VAR1, or the lengths of the individual elements of VARLIST VARLIST1.
@Ln
Calculates the natural logarithm of FN/FNLIST FN1/FNLIST1.
@Log
Calculates the base-10 logarithm of FN/FNLIST FN1/FNLIST1.
@LogReport
Outputs the contents of the variable VAR1 to the API log and on the server console. With FN OPTIONS2 the detailed behavior of the @Function can be defined. FNLIST STYLE3 specifies the font, options, color and size of the …
@LowerCase
Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in lowercase.
@MagicNumber
Returns a MagicNumber for the value FN FN1.
@MainDatabase
Without parameters, @MainDatabase the DBHANDLE for the current main database (AEF DATABASE Statement). With parameters, @MainDatabase works like @OpenDB, but the opened database becomes the new main database. The previou …
@Max
Returns the maximum of FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2. To do this, each element of FNLIST1 is compared with the corresponding element of FNLIST2. If one list is shorter, its last element is used for all …
@MaxPos
Returns the position of the first occurrence of the largest element in FN/FNLIST FN1/FNLIST1. By specifying FN FROM2 and FN TO3 a search range can be defined. If it exceeds the list size, it is reduced to the maximum pos …
@Member
Returns the position at which TEXT/FN TEXT1/FN1 in TEXT/TEXTLIST/IDLIST TEXT2/TEXTLIST2/IDLIST2 is contained in TEXTLIST1/IDLIST1 contains no elements, the result is 0. If @Member is called with PositionList3 then the pa …
@Middle
Returns FN LENGTH3 characters from inside TEXT/TEXTLIST TEXT1/TEXTLIST1. A start position can be selected FN POSITION2 (starting at 0!) or a TEXT TEXT2 can be specified as the position. Note that TEXT2 is not included in …
@MiddleBack
Returns FN LENGTH3 characters from inside TEXT/TEXTLIST TEXT1/TEXTLIST1. A start position can be selected FN POSITION2 (starting at 0!) or a TEXT TEXT2 can be specified as the position. Note that TEXT2 is not included in …
@MimePartAdd
A new MIMEPART segment is appended to HUGEMIMEPART MIMEPART1; the extended MIMEPART field is returned again. FN FNFLAGS2 Flag Hex Dec Kommentar MIME_PART_HAS_BOUNDARY 0001 00001 MIME_PART_HAS_HEADERS 0002 …
@MimePartGet
Returns information about a MIMEPART segment of HUGEMIMEPART MIMEPART1. FN FNSEGMENTNR2 Return FN FNFLAGS3 Flag Hex Dec Kommentar MIME_PART_HAS_BOUNDARY 0001 00001 MIME_PART_HAS_HEADERS 0002 00002 MIM …
@Min
Returns the minimum of FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2. To do this, each element of FNLIST1 is compared with the corresponding element of FNLIST2. If one list is shorter, its last element is used for all …
@MinPos
Returns the position of the first occurrence of the smallest element in FN/FNLIST FN1/FNLIST1. By specifying FN FROM2 and FN TO3 a search range can be defined. If it exceeds the list size, it is reduced to the maximum po …
@Minute
Returns the minutes of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = …
@Modified
Returns the time of the last modification of the document with the NOTEHANDLE NOTEHANDLE1.
@Modulo
Calculates the remainder of the integer division of FN/FNLIST FN1/FNLIST1 durch FN FN2. Decimal places are ignored and no negative remainders are returned; therefore FN1/FNLIST1 and FN2 should be positive integers.
@Month
Returns the month of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = TE …
@MoveFolder
This @Function moves the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2, under the folder mit the VIEWHANDLE VIEWHANDLEPARENTFOLDER3. The folders must be of the same type (shared/privat …
@MySQLClose
Closes a VSPECMYSQL MySQLHandle. The VSPECMYSQL MySQLHandle is returned by @MySQLInit. Return: On success, a closed VSPECMYSQL MySQLHandle; otherwise @Error.
@MySQLConnect
Establishes a connection to the MySQL server. Should be called after @MySQLoptions. The VSPECMYSQL MySQLHandle is provided by @MySQLInit. TEXT Host (for local "" (NULLSTR)) TEXT User (may also be "" (NULLSTR)) TEXT Passw …
@MySQLCreatePreparedStatement
Creates a PreparedStatement query. Such a query represents a kind of template that can then be completed with data to form a complete query and executed. This function is intended for repeated execution of similar querie …
@MySQLFetchRow
Fetches one row from the current position (see @MySQLSeekResult) of a stored result of a @MySQLQuery query. The VSPECMYSQLRES MySQLResultHandle is provided by @MySQLQuery. NOTE: Currently, only one row at a time is suppo …