Engine Help Kategorie: System
Gefilterte Übersicht der Engine-Help-Dokumentation.
@APIServerName
Gibt den Namen (TEXT) des Servers zurück auf dem dieses Programm ausgeführt wird.
@Break
Ohne Parameter: Beendet ein gerade in Bearbeitung befindendes Programm an der Stelle des Auftretens. Außerdem wird die Ausführung des AEF abgebrochen. Mit Parameter (Ab V3.06): FN FN1 = 1: Wie ohne Parameter. FN FN1 = 2: …
@BroadcastNewMail
Versendet die Nachricht über den Empfang eines neuen Mails an die Workstation des Users mit dem Namen TEXT TEXT1. ACHTUNG: Dazu muß auf der Workstation des Users der Server der diese Nachricht versendet als Mail-Server e …
@CacheLogReport
Aktiviert bzw. deaktiviert abhängig vom Argument FN STATE1 die Pufferung der Log-Report-Statements (einschließlich @LogReport). Die @Funktion liefert als Ergebnis den Aktivierungszustand der Pufferung. STATE1: 0 = Puffer …
@CacheLogReportUpdateInterval
Setzt das Intervall (FN1) in dem, bei aktiviertem @CacheLogReport, der APILog Eintrag aktualisiert wird. @CacheLogReportUpdateInterval gibt immer das aktuelle Intervall zurück. (Bei FN1=0 wird nur das aktuelle Intervall …
@CallDEFFNFunction
Ruft die GLOABLe DEFFN Funktion mit dem Namen TEXT TEXTGLOBALGFUNNAME und den folgenden Parametern auf. Die Return-Parameter werden durch die Definition der DEFFN Funktion bestimmt -> siehe FUNKTIONEN. Die GLOBALe DEFFN …
@CallIDF
Ruft ein IDF-Dokument mit dem TEXT IDFNAME1 als Sub-Processing auf. Es wird die Datei mit dem OSPATH OSPATH2 eingezogen. ACHTUNG: Lokale Variablen aus dem Haupt-Processing sind im vom @CallIDF aufgerufenem Programm nicht …
@CallPRC
Ruft ein PRC-Dokument mit dem TEXT PRCNAME1 als Sub-Processing auf. ACHTUNG: Lokale Variablen aus dem Haupt-Processing sind im vom @CallPRC aufgerufenem Programm nicht zugänglich und umgekehrt. Daten (Variablen) können n …
@CheckDefine
Prüft ob ein "Begriff" (der zur bedingten Compilierung genutzt werden kann) definiert ist oder nicht. Ist der "Begriff" definiert gibt @CheckDefine NUMBER 1 (TRUE) zurück. Ist der "Begriff" nicht definiert gibt @CheckDef …
@CheckHandle
Prüft, ob VIEWHANDLE/NOTEHANDLE/DBHANDLE/FILEHANDLE... VIEWHANDLE1/NOTEHANDLE1/DBHANDLE1/FILEHANDLE1... ein geöffneter Handle ist. Wenn ja wird TRUE zurückgegeben, sonst FALSE. FILEHANDLE können allerdings erst ab Versio …
@ClearTaskTimeout
Deaktiviert die Task Timeout Überwachung, für den Task, der @ClearTaskTimeout aufruft. Der Returnwert von @ClearTaskTimeout ist im Erfolgsfall NUMBER 1 sonst @ERROR.
@Clock
Liefert die vergangenen Millisekunden seit dem Start der Engine.
@CloseMutexSemaphore
Schließt die Mutex-Semaphore mit dem Mutex-Semaphore-Handle (MSH) MUTEXSEMAPHOREHANDLE. Im Erfolgsfall wird ein geschlossener Mutex-Semaphore-Handle (MSH) zurückgegeben, andernfalls @ERROR. Eine Mutex-Semaphore kann nur …
@Compare
Vergleicht PAR1 und PAR2 binär auf Identität. Sie können dabei von jeglichem Datentyp sein. Wenn sie identisch sind ist das Ergebnis TRUE ansonsten FALSE. HINWEIS: Es können auch Variablen ungleichen Typ's miteinander ve …
@CompareVPRList
Es werden jeweils die korrespondierenden Elemente verglichen. (Variable 1 aus VPRList1 mit Variable 1 aus VPRList2,Variable 2 aus VPRList1 mit Variable 2 aus VPRList2,...) Mit zwei Parametern (Der Vergleich erfolgt mit d …
@CreateBuffer
Mit @CreateBuffer wird ein Binär-Puffer vom Datentyp BINBUFFER erstellt. Return: Einen Handle auf den allokierten Binär-Puffer vom Datentyp BINBUFFER oder @Error. FN FNSIZE1: Größe des Binär-Puffers. FN FNUSEDSIZE2: Benu …
@CreateMutexSemaphore
Erzeugt eine Mutex-Semaphore mit dem Namen TEXT TEXTSEMAPHORENAME. Im Erfolgsfall wird ein Mutex-Semaphore-Handle (MSH) zurückgegeben, andernfalls @ERROR. Eine Mutex-Semaphore kann nur von einem Task zu einem Zeitpunkt b …
@Define
Definiert einen "Begriff" der zur bedingten Compilierung genutzt werden kann. Im Unterschied zum Keyword DEFINE wird @Define zur Ausführungszeit (und nur wenn dieser @Define ausgeführt wird) wirksam. TEXT1 darf keine Spa …
@DeleteLogEntry
Über diese @Function wird bestimmt, ob das APILog-Dokument zu diesem Task, nach Beendigung des Tasks, gelöscht werden soll, oder nicht. FN FN1: DEC Bedeutung 32768 Dokument löschen 0 Dokument nicht löschen 3 Stat …
@DestroyBuffer
Mit @DestroyBuffer wird ein Binär-Puffer vom Datentyp BINBUFFER wieder frei gegeben. Return: Einen Handle auf einen "zerstörten" Binär-Puffer vom Datentyp BINBUFFER oder @Error.
@EngineDown
Beendet den APIEngine-Task auf dem Server.
@Execute
Startet ein OS/2-EXE Programm OSPATH OSPATH1 mit den Parametern TEXT TEXT2 im Modus FN MODE3 als Child-Process der API-Engine. MODE3: 0 = Start des Child-Process und parallele Fortführung des API-Engine Programms. 1 = St …
@GetAEFName
Gibt den Namen des aktuell von diesem Task abgearbeiteten AEF-Document zurück.
@GetAllocMem
Gibt die Größe des aktuell vom Programm physikalisch belegten dynamischen Speicher zurück.
@GetApiLogDocInfo
Diese @Funktion gibt den DBHANDLE DBHANDLE1 und den NOTEHANDLE NOTEHANDLE2 des aktuellen APILOG Documentes zurück. Der Return-Wert der @Funktion ist stets TRUE. Sind die Werte nicht verfügbar, wird in DBHANDLE1 und NOTEH …
@GetBufferInfo
Gibt Informationen zu dem BINBUFFER mit dem BUFFERHANDLE BUFFERHANDLE1 zurück. Als Rückgabewert wird der Buffer-Pointer zurückgegeben. Der Buffer-Pointer ist tatsächlich ein physischer Pointer in den eigentlichen Speiche …
@GetDataType
Gibt in ein bis vier Zeichen den Datentyp der Variable VAR1 zurück. Datentyp: Rückgabewert: TEXT A TEXTLIST AL NUMBER N NUMBERLIST NL FLOAT F FLOATLIST FL TD T TDLIST TL RT (RICHTEXT) RT ID …
@GetDEFFNGlobal
Gibt die Namen aller GLOBAL mit DEFFN definierten Funktionen zurück.
@GetDeleteCount
Gibt die Anzahl der aktuell vom Programm gelöschten Dokumente zurück.
@GetDiskSpace
Gibt in einer FLOATLIST den benutzten und freien Platz des Laufwerks mit dem Buchstaben TEXT OSDRIVE1 zurück: 1.Element: benutzter Platz 2.Element: freier Platz
@GetDoneCount
Gibt die Anzahl der aktuell vom Programm (IDF) behandelten Dokumente zurück.
@GetEngineTasks
Gibt eine Liste (TEXTLIST) der beim Aufruf der @Funktion aktiven Engine-Tasks zurück.
@GetFieldFlags
Gibt die Field-Flags für Notes von einer Variable zurück. Field-Flags: 1 SIGN 2 SEAL 4 SUMMARY 16 SEALED 32 READ/WRITE-ACCESS 64 NAMES 256 PLACEHOLDER 512 PROTECTED 1024 READ-ACCESS Praktische Beispiele …
@GetHexDump
@GetHexDump gibt den Inhalt der Varibale VAR als Hex-Dump zurück. VAR darf jeden Typs sein, mit Ausnahme von HUGE-Datentypen*. *HUGE-Datentypen (siehe @GetDataType): VHUGEHUGEITEM HI VHUGERTCOMPONENTS RC VHUGEH …
@GetOpenDBs
Gibt die Anzahl der aktuell vom Programm geöffneten Datenbanken zurück.
@GetOpenNotes
Gibt die Anzahl der aktuell vom Programm geöffneten Dokumente zurück.
@GetOpenViews
Gibt die Anzahl der aktuell vom Programm geöffneten Ansichten zurück.
@GetOSFileCreated
Gibt den Zeitpunkt der Erstellung eines (OSPATH1) oder meherer (OSPATHLIST1) OSFiles zurück. Zurückgegeben wird eine TDList die an der Position, an der der OSPath des Files in der OSPATHLIST1 steht, den TD-Wert der Erste …
@GetOSFileModified
Gibt den Zeitpunkt der letzten Änderung eines (OSPATH1) oder meherer (OSPATHLIST1) OSFiles zurück. Zurückgegeben wird eine TDList die an der Position, an der der OSPath des Files in der OSPATHLIST1 steht, den TD-Wert der …
@GetStartDocInfo
Diese @Funktion gibt den DBHANDLE und die NOTEID des Dokumentes zurück das den Start dieses Programms verursacht hat. In DBHANDLE1 wird der DBHANDLE der Datenbank zurückgegeben in dem sich das auslösende Dokument befinde …
@GetSysInfo
Holt die durch TEXT/TEXTLIST TEXT1/TEXTLIST1 spezifizierten System-Informationen und gibt sie als TEXT/TEXTLIST zurück. TEXT/TEXTLIST: OS Versions-Nummer des Betriebs-Systems LN Versions-Nummer des Lotus-Notes-Server …
@GetSysMemInfo
Nur für Engine unter Windows! Gibt betriebssystemspezifische Informationen zum Speicherverbrauch des Engine-Process zurück. FN RetFNWorkingSet In diesem Parameter wird der momentane Gesamtspeicherverbrauch (RAM) des Engi …
@GetTickCount
Gibt die vergangenen Millisekunden (ms) seit dem Systemstart als FN zurück. Die Auflösung ist vom System abhängig und liegt typischerweise zwischen 10 und 16 ms.
@GetUpdateCount
Gibt die Anzahl der aktuell vom Programm geänderten (und auch erstellten) Dokumente zurück.
@GetUsedMem
Gibt die Größe des aktuell vom Programm belegten dynamischen Speicher zurück.
@GetVacantMem
Gibt die Größe des aktuell vom Programm physikalisch belegten dynamischen Speicher, der derzeit nicht genutzt wird zurück.
@GetVarByVPR
Liefert zur VPR (Variable Pointer Referenz) einer Variable den Inhalt der Variable zurück, auf die verwiesen wird.
@GetVarFromVar
Gibt die Variable TEXT/RT/FN/TD TEXT1/RT1/FN1/TD1 ab Position FN FN2 für FN FN3 Stellen zurück. In TEXT TYPE4 wird festgelegt, als welcher Datentyp der Rückgabewert zu interpretieren ist. RETTYPE4: A=TEXT B=Binär (RT) F= …
@GetVarVPR
Bei Aufruf von @GetVarVPR mit einem Parameter wird die VPR (Variable Pointer Referenz) auf die übergebene Variable zurückgegeben. Bei einem Aufruf mit zwei Parameteren wird die Variable auf dem VStack TEXT TEXT2 und dem …
@GetVarVPRList
Gibt eine VPRList der Variable(n) VAR1-VAR99 zurück. ACHTUNG: Eine VPRList ist eine Liste von Handle auf Variablen. Daraus folgt, wenn der Inhalt einer Variable geändert wird, die in einer VPRList angegeben ist, wird bei …