Engine Help: I
Filtered overview of the Engine Help documentation.
@IDList
Returns a variable of type IDLIST with 0 elements.
@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 …
IDF Document
An IDF Document contains an Engine Import Script program. This is the old name for an Import Script Document, but Batch Scriptsis still used in Batch Scripts and in commands (Commands), for compatibility reasons. Note : …
IENGINE.EXE / NENGINE.EXE
The Engine program files. these are contained within the NOTES PROGRAM ROOT directory. See: NOTES.INI NOTES PROGRAM ROOT NOTES DATA ROOT APICTRL.NSF APILOG PRG Document AEF Document PRC Document IDF Document Notes Server
IMPORT IDF
IMPORT IDF imports data from the file import_file into Notes documents in the current main database. The structure and conversion of the data is specified in the IDF file idf_file.
INCLUDE
As of version 4.50 B169: Include: Syntax: INCLUDE("INCLUDE_SUB_SCRIPT"); INCLUDE can be used to include the code of an Engine Script Document in another Engine Script. Nested includes are also possible. Local DEFFN funct …
Installation of the Engine
Shut down the Notes server (Exit) on which you want to install the Engine. Add the following entries to the NOTES.INI: APILogFileName=(NAME OF YOUR API LOG FILE, e.g. SYSTEM\APILOG.NSF) APILogFileEntries=130,8000 APIKeyF …