Engine Help: Function
Filtered overview of the Engine Help documentation.
@DeleteNote
Deletes a document with the NOTEHANDLE NOTEHANDLE1 in of the database with the DBHANDLE DBHANDLE2. The document must have been opened beforehand. Deleting it automatically closes it. In FN FNUPDFLAGS3 can Optionen specif …
@DeleteNoteByID
Deletes the document or documents with the NOTEID NOTEID2, or with the NOTEIDLIST NOTEID2, in the database with the DBHANDLE DBHANDLE1. If the operation was completed successfully, the @Function result is the number of d …
@DeleteNoteByPosition
Deletes a document in the database with DBHANDLE DBHANDLE1 in the view with VIEWHANDLE VIEWHANDLE2 at position VIEWPOSITION/VIEWPOS VIEWPOSITION3. The document must not be opened. If the operation was executed successful …
@DeleteOSDirectory
Syntax 1: Deletes the directory with OSPATH OSPATH1. Syntax 2: Deletes the directories specified in the OSPATHLIST OSPATHLIST1 are specified. A directory must be empty before it can be deleted.
@DeleteOSFile
Syntax 1: Deletes the file with OSPATH OSPATH1. Syntax 2: Deletes the files specified in the OSPATHLIST OSPATHLIST1 are specified. A NUMBERLIST is returned; at each corresponding position parallel to TEXT1/TEXTLIST1, 1 i …
@DestroyBuffer
With @DestroyBuffer, a binary buffer of data type BINBUFFER is released again. Return: A handle to a "destroyed" binary buffer of data type BINBUFFER or @Error.
@DetachOSFileFromNote
Deletes one or more files from the document with NOTEHANDLE NOTEHANDLE1 whose file name(s) are specified in TEXT/TEXTLIST TEXT1/TEXTLIST1 or whose list position numbers (@AttachmentInfo) are specified in FN/FNLIST FN1/FN …
@DigitsToText
Converts the ASCII-CHAR values in TEXT/TEXTLIST TEXT1/TEXTLIST1 to the corresponding ASCII texts and returns them as TEXT/TEXTLIST. The second parameter specifies the number system in which the ASCII-CHAR values in TEXT1 …
@DNSQuery
Currently available for Windows only!!! Sends a query via UDP to the DNS server with the Internet IP address TEXT IPADDRESS1 and returns the result as TEXTLIST . Each element represents a record whose fields are separate …
@DNSQueryAddress
Currently available for Windows only!!! Returns the Internet IP address for the specified host TEXT TEXT1 . The different settings of the current system of the executing server are used.
@DNSQueryHost
Currently available for Windows only!!! Returns the official host name for an Internet IP address TEXT TEXT1 . The different settings of the current system of the executing server are used.
@DocLength
Returns the size of the document with the NOTEHANDLE NOTEHANDLE1 (object size of the document without attachments). If @DocLength is used in the second format, the lengths of the contents of the fields (and the attachmen …
@Dump
Outputs the contents of the variable VAR as a dump (memory dump) to a file in the Notes server data directory. The file name consists of the first 8 characters of the variable name + ".DMP". With OSPATH OSPATH2, to alter …
@Elements
Returns the number of elements of FNLIST/TEXTLIST/TDLIST/IDLIST FNLIST1/TEXTLIST1/TDLIST1/IDLIST. If no list is passed to the @Function as an argument, the @Function result is 1.
@EngineDown
Terminates the APIEngine task on the server.
@Environment
Returns the value of the environment variable TEXT/TEXTLIST TEXT1/TEXTLIST1.
@Execute
Starts an OS/2 EXE program OSPATH OSPATH1 with the parameters TEXT TEXT2 in mode FN MODE3 as a child process of the API Engine. MODE3: 0 = Starts the child process and continues the API Engine program in parallel. 1 = St …
@ExecuteAgent
This @Function executes the agent with the AGENTHANDLE AGENTHANDLE1 either against all documents (without the parameter NOTEHANDLE NOTEHANDLE3) of the DB in which the agent is located, or against a single document, with …
@ExpandGroups
In TEXT/TEXTLIST TEXT1/TEXTLIST1, all specified group names are replaced by their members. Unknown group names are retained, and the resulting list is returned as the @Function result. TEXTLIST TEXTLIST2 additionally ret …
@Explode
Splits the TEXT/TEXTLIST TEXT1/TEXTLIST1 into a TEXTLIST. At each occurrence of a space, the TEXT1 or each element of TEXTLIST1 is separated and made into its own element. TEXT SEPTEXT2 can be used to specify a different …
@ExtractOSFileFromNote
Copies one or more file attachments, whose names or positions (see @AttachmentInfo) in TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 are specified, from the document with the NOTEHANDLE NOTEHANDLE1 as files to a dr …
@FileLength
Returns the size of the file with the OSPATH OSPATH1.
@FindCategoryByName
Searches in the view with the VIEWHANDLE VIEWHANDLE1 the category with the name TEXT/TEXTLIST NAME2 ab the VIEWPOSITION VIEWPOSITION3 and liefert the VIEWPOSITION on success. VIEWPOSITION3 is an FNLIST with 10 entries. T …
@FindDocumentsByKey
Searches in the view with the VIEWHANDLE VIEWHANDLE1 the category(n) with the name TEXT/TEXTLIST NAME2 and liefert a VIEWPOS on success. If NAME2 is a TEXTLIST, the elements for einander is searched for in the sorted col …
@FloatToNumber
Converts FN FN1 or FNLIST FNLIST1 into a NUMBER or NUMBERLIST; any existing decimal places are truncated. HINWEIS:NOTE: All numeric constants in the APIEngine are of type FLOAT/FLOATLIST. ACHTUNG:IMPORTANT: The range of …
@FolderAddDoc
This @Function adds, in the DB with the DBHANDLE DBHANDLE1, the documents,whose NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 can be specified, in the Folder with the VIEWHANDLE VIEWHANDLEFOLDER2 a. Return value: If t …
@FolderRemoveDoc
This @Function removes, in the DB with the DBHANDLE DBHANDLE1, the documents whose NOTEIDs can be specified in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 from the folder with the VIEWHANDLE VIEWHANDLEFOLDER2. (The document is …
@FTDeleteIndex
The full-text index of the DB with the DBHANDLE DBHANDLE1 is (if present) deleted. Return value: Im success TRUE, otherwise @Error.
@FTGetLastIndexTime
Returns the time of the last full-text indexing of the DB with the DBHANDLE DBHANDLE1 as TD. If a DB is not full-text indexed, @ERROR is returned.
@FTGetSize
Returns the size (in bytes) of the full-text index of the DB with the DBHANDLE DBHANDLE1 as FN. If a DB is not full-text indexed, 0 is returned.
@FTIndex
Indexes the DB with the DBHANDLE DBHANDLE1, taking into account the options specified under FN FN2. (At present, only databases located locally on the server can be indexed.) In TEXT OSPATH3, a STOP-WORD-FILE can optiona …
@FTPNTClose
This @Function is available only on Windows! Closes an FTP session. The FTP session with the FTPNTHANDLE FTPNTHANDLE is closed. On success, the @Function returns an FTPNT handle NULLHANDLE; otherwise, @Error.
@FTPNTCloseFind
This @Function is available only on Windows! Closes an FTP find session. The FTP find session with the FTPNTFINDHANDLE FTPNTFINDHANDLE is closed. On success, the @Function returns an FTPNTFIND handle NULLHANDLE; otherwis …
@FTPNTFindFirstFile
This @Function is available only on Windows! TEXT TEXTPATTERN specifies the file name with the search criteria (wildcards, for example "*.jpg"). Returns the current directory path on the FTP server. On success, the @Func …
@FTPNTFindNextFile
This @Function is available only on Windows! Returns the current directory path on the FTP server. On success, the @Function returns a TEXT containing the current directory path; otherwise, @Error. TEXT RETTEXTATTRIBUTES …
@FTPNTGetConnectionInfo
This @Function is available only on Windows! Returns connection data for the FTPNTHANDLE FTPNTHANDLE. TEXT RETTEXTAPPLICATION The application text that was specified when opening the session. TEXT RETTEXTSERVER The serve …
@FTPNTGetCurrentDirectory
This @Function is available only on Windows! Returns the current directory path on the FTP server. On success, the @Function returns a TEXT containing the current directory path; otherwise, @Error.
@FTPNTGetFile
Retrieves the file with the name TEXT TEXTREMOTENAME from the current directory on the FTP server of the FTP session with the FTPNTHANDLE FTPNTHANDLE. TEXT TEXTREMOTENAME can also be a fully qualified path or a relative …
@FTPNTGetLastError
This @Function is available only on Windows! Returns the last error code. Note : This text was machine-translated and may contain inaccuracies.
@FTPNTGetLastResponseInfo
This @Function is available only on Windows! Returns the last FTP server response. This function is useful, for example, when @FTPNTGetLastError returns code 12003. In this case, the FTP server response may help narrow d …
@FTPNTOpen
This @Function is available only on Windows! Starts an FTP session. TEXT APPLICATIONTEXT specifies the name of the application or service. This name is passed on in the FTP protocol. FN FNCONNECTIONFLAGS: 0 Active m …
@FTPNTScanOSDirectory
Searches the current directory on the FTP server of the FTP session with the FTPNTHANDLE FTPNTHANDLE for files contained in it. TEXT TEXTPATTERN specifies the file name with the search criteria (wildcards, for example "* …
@FTPNTSetCurrentDirectory
This @Function is available only on Windows! Sets the current directory path on the FTP server. On success, the @Function returns a TRUE; otherwise, @Error.
@FtSearch
@FtSearch performs the actual search defined by FTSEARCHHANDLE FTSEARCHHANDLE1. The parameter FN FNLIMIT2 can be used to limit the number of documents found. If 0 is specified here, all documents are found. The parameter …
@GetACL
Retrieves the ACL of the database with the OSPATH OSPATH1 or DBHANDLE DBHANDLE1 and returns it split into TEXTLIST USERNAMES2, NUMBERLIST USERLEVEL3, TEXTLIST USERPRIVS4 and TEXTLIST PRIVNAMES5. USERNAMES2: The ACL name …
@GetACLHistory
The ACL change history of the DB with the DBHANDLE DBHANDLE1 as TEXTLIST is returned. Example @GetACLHistory(DBHANDLE1): DBHANDLE1:=@OpenDB("TEST.NSF"); @LogReport(@GetACLHistory(DBHANDLE1)); DBHANDLE1:=@CloseDB(DBHANDLE …
@GetACLMaxINetAccess
Returns the maximum Internet access of the DB with the DBHANDLE DBHANDLE1. LEVEL: 6=Manager 5=Developer 4=Editor 3=Author 2=Depositor 1=Reader 0=No Access Return: FN -> Success @Error -> Error @ERROR ACL NOT …
@GetAEFName
Returns the name of the AEF-Document.
@GetAllocMem
Returns the size of the dynamic memory currently physically allocated by the program.
@GetApiLogDocInfo
This @Function returns the DBHANDLE DBHANDLE1 and the NOTEHANDLE NOTEHANDLE2 of the current APILOG document. The return value of the @Function is always TRUE. If the values are not available, the data type DBHANDLE1 and …