Engine Help Category: System
Filtered overview of the Engine Help documentation.
@APIServerName
Returns the name (TEXT) of the server on which this program is executed.
@Break
Ohne Parameter: Terminates a program currently being processed at the point where it occurs. In addition, execution of the AEF is aborted. Mit Parameter (Ab V3.06): FN FN1 = 1: Wie ohne Parameter. FN FN1 = 2: Terminates …
@BroadcastNewMail
Sends the notification about the receipt of new mail to the workstation of the user named TEXT TEXT1. ACHTUNG: For this, the server that sends this notification must be configured as the mail server on the user's worksta …
@CacheLogReport
Aktiviert or deaktiviert abhaengig vom Argument FN STATE1 buffering of LogReport statements (including @LogReport). The @Function returns the activation state of buffering as the result. STATE1: 0 = buffering off. 1 = bu …
@CacheLogReportUpdateInterval
Sets the interval (FN1) at which, when @CacheLogReport is enabled, the APILog entry is updated. @CacheLogReportUpdateInterval always returns the current interval. (For FN1=0 only the current interval is returned.)
@CallDEFFNFunction
Calls the GLOABLe DEFFN function named TEXT TEXTGLOBALGFUNNAME and the following parameters. The return parameters are determined by the definition of the DEFFN function definition -> see FUNKTIONEN. The GLOBALe DEFFN fu …
@CallIDF
Calls an IDF document with the TEXT IDFNAME1 as sub-processing. The file with the OSPATH OSPATH2 is imported. ACHTUNG: Local variables from the main processing are not accessible in the program called by @CallIDF, and vi …
@CallPRC
Calls a PRC document with the TEXT PRCNAME1 as sub-processing. ACHTUNG: Local variables from the main processing are not accessible in the program called by @CallPRC, and vice versa. Data (variables) can only be exchange …
@CheckDefine
Checks whether a "term" (which can be used for conditional compilation) is defined or not. If the "term" is defined, @CheckDefine NUMBER 1 (TRUE) back. If the "term" is not defined, @CheckDefine NUMBER 0 (FALSE) back. TE …
@CheckHandle
Checks whether VIEWHANDLE/NOTEHANDLE/DBHANDLE/FILEHANDLE... VIEWHANDLE1/NOTEHANDLE1/DBHANDLE1/FILEHANDLE1... is an open handle. If yes, TRUE returned, otherwise FALSE. FILEHANDLE can only be checked as of version 1.93.
@ClearTaskTimeout
Disables task timeout monitoring for the task that @ClearTaskTimeout onruft. The return value of @ClearTaskTimeout is in the case of success NUMBER 1, otherwise @ERROR.
@Clock
Returns the milliseconds elapsed since the Engine was started.
@CloseMutexSemaphore
Closes the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE. On success a closed mutex semaphore-Handle (MSH) is returned, otherwise @ERROR. A mutex semaphore can be owned (requested) by only on …
@Compare
comparisont PAR1 and PAR2 for binary identity. They may be of any data type. If they are identical, the result is TRUE ansonsten FALSE. NOTE: Variables of different types can also be compared, because only the binary con …
@CompareVPRList
The corresponding elements are compared in each case. (variable 1 from VPRList1 with variable 1 from VPRList2, variable 2 from VPRList1 with variable 2 from VPRList2,...) With two parameters (The comparison is performed …
@CreateBuffer
With @CreateBuffer, a binary buffer of data type BINBUFFER is created. Return: A handle to the allocated binary buffer of data type BINBUFFER or @Error. FN FNSIZE1: Size of the binary buffer. FN FNUSEDSIZE2: Set the used …
@CreateMutexSemaphore
Creates a mutex semaphore named TEXT TEXTSEMAPHORENAME. On success, a mutex semaphore handle (MSH) is returned; otherwise @ERROR. A mutex semaphore can be owned (requested) by only one task at a time. (This is used to al …
@Define
Defines a "term" that can be used for conditional compilation. Unlike the keyword DEFINE is @Define at runtime (and only if this @Define is executed) effective. TEXT1 must not contain spaces (" ") or special characters ( …
@DeleteLogEntry
This @function determines whether the APILog document for this task should be deleted after the task has ended or not. FN FN1: DEC Meaning 32768 Delete document 0 Do not delete document 3 Query status, but do not …
@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.
@EngineDown
Terminates the APIEngine task on the server.
@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 …
@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 …
@GetBufferInfo
Returns information about the BINBUFFER with the BUFFERHANDLE BUFFERHANDLE1 is returned. The buffer pointer is returned as the return value. FN RETFNUSEDSIZE: The currently used size of the buffer. FN RETFNALLOCSIZE: The …
@GetDataType
Returns the data type of the variable VAR1. Data type: Return value: TEXT A TEXTLIST AL NUMBER N NUMBERLIST NL FLOAT F FLOATLIST FL TD T TDLIST TL RT (RICHTEXT) RT ID I IDLIST IL UNIDLIST …
@GetDEFFNGlobal
Returns the names of all GLOBAL functions defined with DEFFN defined functions.
@GetDeleteCount
Returns the number of documents currently deleted by the program.
@GetDiskSpace
Returns in a FLOATLIST the used and free space of the drive with the letter TEXT OSDRIVE1: 1.Element: benutzter Platz 2.Element: freier Platz
@GetDoneCount
Returns the number of documents currently processed by the progron (IDF).
@GetEngineTasks
Returns a list (TEXTLIST) the Engine tasks active when the @function is called.
@GetFieldFlags
Returns the Notes field flags of a varifromle. Field-Flags: 1 SIGN 2 SEAL 4 SUMMARY 16 SEALED 32 READ/WRITE-ACCESS 64 NAMES 256 PLACEHOLDER 512 PROTECTED 1024 READ-ACCESS Practical examples of combinati …
@GetHexDump
@GetHexDump returns the content of the variable VAR as a hex dump. VAR may be of any type, except HUGE data types*. *HUGE data types (see @GetDataType): VHUGEHUGEITEM HI VHUGERTCOMPONENTS RC VHUGEHUGERT …
@GetOpenDBs
Returns the number the currently from the Programm openedn databaseen.
@GetOpenNotes
Returns the number the currently from the opened documents by this program.
@GetOpenViews
Returns the number of the currently opened view by this program.
@GetOSFileCreated
Returns the creation time of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD value for the cr …
@GetOSFileModified
Returns the time of the last modification of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD …
@GetStartDocInfo
This @Function returns the DBHANDLE and the NOTEID of the document that caused this program to start. In DBHANDLE1 is the DBHANDLE of the database containing the triggering document is returned. In ID2 the NOTEID of the …
@GetSysInfo
Gets the system information specified by TEXT/TEXTLIST TEXT1/TEXTLIST1 and returns it as TEXT/TEXTLIST is returned. TEXT/TEXTLIST: OS Version number of the operating system LN Version number of the Lotus Notes server …
@GetSysMemInfo
Only for Engine under Windows! Returns operating-system-specific information about the memory usage of the Engine process. FN RetFNWorkingSet This parameter returns the current total memory usage (RAM) of the Engine proc …
@GetTickCount
Returns the milliseconds (ms) elapsed since system startup as FN is returned. The resolution depends on the system and is typically between 10 and 16 ms.
@GetUpdateCount
Returns the number of documents currently modified (and also created) by the program.
@GetUsedMem
Returns the size of the dynamic memory currently occupied by the program.
@GetVacantMem
Returns the size of the dynamic memory physically occupied by the program that is currently not being used.
@GetVarByVPR
For the VPR (Variable Pointer Reference) of a variable, returns the content of the variable being referenced.
@GetVarFromVar
Returns the variable TEXT/RT/FN/TD TEXT1/RT1/FN1/TD1 ab Position FN FN2 for FN FN3 characters. In TEXT TYPE4 specifies the data type as which the return value is to be interpreted. RETTYPE4: A=TEXT B=Binär (RT) F=FLOAT N …
@GetVarVPR
When @GetVarVPR is called with one parameter, the VPR (Variable Pointer Reference) for the passed variable is returned. When called with two parameters, the variable with the name TEXT TEXT1 is searched for on the VStack …
@GetVarVPRList
Returns a VPRList for the variable(s) VAR1-VAR99 is returned. IMPORTANT: A VPRList is a list of handles to variables. This means that if the content of a variable specified in a VPRList is changed, this changed content i …