Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@DeleteNote
Löscht ein Dokument mit dem NOTEHANDLE NOTEHANDLE1 in der Datenbank mit dem DBHANDLE DBHANDLE2. Das Dokument muß zuvor geöffnet worden sein. Mit dem Löschen wird es automatisch geschlossen. In FN FNUPDFLAGS3 können Optio …
@DeleteNoteByID
Löscht das Dokument bzw. die Dokumente mit der NOTEID NOTEID2 bzw. NOTEIDLIST NOTEID2 in der Datenbank mit dem DBHANDLE DBHANDLE1. Wurde die Operation erfolgreich durchgeführt ist das @Funktions-Ergebnis die Anzahl der g …
@DeleteNoteByPosition
Löscht ein Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 in der Ansicht mit dem VIEWHANDLE VIEWHANDLE2 an der Position VIEWPOSITION/VIEWPOS VIEWPOSITION3. Das Dokument muß bzw. darf nicht geöffnet werden. Wurde di …
@DeleteOSDirectory
Syntax 1: Löscht das Verzeichnis mit dem OSPATH OSPATH1. Syntax 2: Löscht die Verzeichnise die in der OSPATHLIST OSPATHLIST1 angegeben sind. Damit ein Verzeichnis gelöscht werden kann, muß es leer sein !!! Beipiel: @Dele …
@DeleteOSFile
Syntax 1: Löscht das File mit dem OSPATH OSPATH1. Syntax 2: Löscht die Files die in der OSPATHLIST OSPATHLIST1 angegeben sind. Als Return-Wert wird eine NUMBERLIST zurückgegeben, für die an der jeweiligen Position parall …
@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.
@DetachOSFileFromNote
Löscht eine oder mehrere Dateien aus dem Dokument mit dem NOTEHANDLE NOTEHANDLE1 deren FileName(s) in dem/der TEXT/TEXTLISTE TEXT1/TEXTLIST1 bzw. deren Listen-Positions-Nummern (@AttachmentInfo) in FN/FNLIST FN1/FNLIST1 …
@DigitsToText
Wandelt die ASCII-CHAR Werte in TEXT/TEXTLIST TEXT1/TEXTLIST1 in die dazugehörigen ASCII-Texte um und gibt sie als TEXT/TEXTLIST wieder zurück. Im zweiten Parameter wird angegeben in welchem Zahlensystem die ASCII-CHAR W …
@DNSQuery
Derzeit nur für Windows verfügbar!!! Schickt eine Anfrage über UDP an den DNS-Server mit Internet-IP-Adresse TEXT IPADDRESS1 und gibt das Ergebnis als TEXTLIST zurück. Jedes Element stellt dabei einen Record dar, dessen …
@DNSQueryAddress
Derzeit nur für Windows verfügbar!!! Liefert die Internet-IP-Adresse für den übergebenen Host TEXT TEXT1 zurück. Dabei werden die unterschiedlichen Einstellungen des aktuellen Systems des ausführenden Server verwendet.
@DNSQueryHost
Derzeit nur für Windows verfügbar!!! Liefert den offizellen Hostnamen zu einer Internet-IP-Adresse TEXT TEXT1 zurück. Dabei werden die unterschiedlichen Einstellungen des aktuellen Systems des ausführenden Server verwend …
@DocLength
Gibt die Größe des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück (Objectgröße des Dokuments ohne Attachments). Wird @DocLength im zweiten Format angewandt werden die Längen der Inhalte der Felder (und die Attachments) …
@Dump
Gibt den Inhalt der Variable VAR als Dump (Speicherauszug) in einer Datei im Datenverzeichnis des Notes-Servers aus. Der Dateiname besteht aus den ersten 8 Zeichen des Variablenamens + ".DMP". Mit OSPATH OSPATH2 kann ein …
@Elements
Gibt die Anzahl der Elemente von FNLIST/TEXTLIST/TDLIST/IDLIST FNLIST1/TEXTLIST1/TDLIST1/IDLIST zurück. Wird der @Funktion keine Liste als Argument übergeben, ist das @Funktions-Ergebnis 1.
@EngineDown
Beendet den APIEngine-Task auf dem Server.
@Environment
Liefert den Wert der Umgebungsvariable TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück.
@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 …
@ExecuteAgent
Diese @Function führt den Agent mit dem AGENTHANDLE AGENTHANDLE1 entweder gegen alle Dokumente (Ohne Parameter NOTEHANDLE NOTEHANDLE3) der DB, in der sich der Agent befindet, oder gegen ein einzelnes Dokument, mit dem NO …
@ExpandGroups
In TEXT/TEXTLIST TEXT1/TEXTLIST1 werden alle angegebenen Gruppennamen durch ihre Mitglieder ersetzt. Dabei bleiben unbekannte Gruppennamen erhalten und die so entstandene Liste wird als @Funktionsergebnis zurückgegeben. …
@Explode
Zerlegt den TEXT/TEXTLIST TEXT1/TEXTLIST1 in eine TEXTLIST. Dabei wird bei jedem Auftreten eines Leerzeichens der TEXT1 bzw. jedes Element von TEXTLIST1 abgetrennt und zu einem eigenen Element gemacht. Mit TEXT SEPTEXT2 …
@ExtractOSFileFromNote
Kopiert eines oder mehrere File-Attachments, deren Namen oder Position(en) (siehe @AttachmentInfo) in TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 angegeben wird/werden, aus dem Dokument mit dem NOTEHANDLE NOTEHAN …
@FileLength
Gibt die Größe der Datei mit dem OSPATH OSPATH1 zurück.
@FindCategoryByName
Sucht in der Ansicht mit dem VIEWHANDLE VIEWHANDLE1 die Kategorie mit dem Namen TEXT/TEXTLIST NAME2 ab der VIEWPOSITION VIEWPOSITION3 und liefert die VIEWPOSITION im Erfolgsfall zurück. VIEWPOSITION3 ist eine FNLIST mit …
@FindDocumentsByKey
Sucht in der Ansicht mit dem VIEWHANDLE VIEWHANDLE1 die Kategorie(n) mit dem Namen TEXT/TEXTLIST NAME2 und liefert eine VIEWPOS im Erfolgsfall zurück. Ist NAME2 eine TEXTLIST, werden die Elemente nach einander in den sor …
@FloatToNumber
Wandelt FN FN1 bzw. FNLIST FNLIST1 in eine NUMBER bzw. NUMBERLIST um, dabei werden vorhandene Nachkommastellen abgeschnitten. HINWEIS: Alle Zahl-Konstanten sind in der APIEngine vom Typ FLOAT/FLOATLIST. ACHTUNG: Der Bere …
@FolderAddDoc
Diese @Function fügt, in der DB mit dem DBHANDLE DBHANDLE1, die Dokumente ,deren NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 angegeben werden, in den Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2 ein. ReturnWert: Wurd …
@FolderRemoveDoc
Diese @Function entfernt, in der DB mit dem DBHANDLE DBHANDLE1, die Dokumente ,deren NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 angegeben werden, aus dem Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2. (Das Dokument w …
@FTDeleteIndex
Der Full-Text-Index der DB mit dem DBHANDLE DBHANDLE1 wird (wenn vorhanden) gelöscht. ReturnWert: Im Erfolgsfall TRUE, sonst @Error.
@FTGetLastIndexTime
Gibt den Zeitpunkt der letzten Full-Text-Indizierung der DB mit dem DBHANDLE DBHANDLE1 als TD zurück. Ist eine DB nicht Full-Text-Indiziert wird @ERROR zurückgegeben.
@FTGetSize
Gibt die Größe (in Byte) des Full-Text-Index der DB mit dem DBHANDLE DBHANDLE1 als FN zurück. Ist eine DB nicht Full-Text-Indiziert wird 0 zurückgegeben.
@FTIndex
Indiziert die DB mit dem DBHANDLE DBHANDLE1 unter Berücksichtigung der unter FN FN2 angegebenen Optionen. (Zur Zeit können nur lokal auf dem Server liegende Datenbanken indiziert werden.) In TEXT OSPATH3 kann optional ei …
@FTPNTClose
Diese @Function steht nur unter Windows zur Verfügung! Beendet eine FTP-Session. Die FTP-Session mit dem FTPNTHANDLE FTPNTHANDLE wird beendet. Im Erfolgsfall liefert die @Function einen FTPNT-Handle-NULLHANDLE zurück, so …
@FTPNTCloseFind
Diese @Function steht nur unter Windows zur Verfügung! Beendet eine FTP-Find-Session. Die FTP-Find-Session mit dem FTPNTFINDHANDLE FTPNTFINDHANDLE wird beendet. Im Erfolgsfall liefert die @Function einen FTPNTFIND-Handle …
@FTPNTFindFirstFile
Diese @Function steht nur unter Windows zur Verfügung! In TEXT TEXTPATTERN wird der FileName mit den Suchkriterien angegeben (WILDCARDS... z.b. "*.jpg"). Gibt den aktuellen Verzeichnis-Pfad auf dem FTP-Server zurück. Im …
@FTPNTFindNextFile
Diese @Function steht nur unter Windows zur Verfügung! Gibt den aktuellen Verzeichnis-Pfad auf dem FTP-Server zurück. Im Erfolgsfall liefert die @Function einen TEXT mit dem aktuellem Verzeihnis-Pfad zurück, sonst @Error …
@FTPNTGetConnectionInfo
Diese @Function steht nur unter Windows zur Verfügung! Gibt Verbindungs-Daten zu dem FTPNTHANDLE FTPNTHANDLE zurück. TEXT RETTEXTAPPLICATION Der Application-Text der beim Öffnen angegeben wurde. TEXT RETTEXTSERVER Die Se …
@FTPNTGetCurrentDirectory
Diese @Function steht nur unter Windows zur Verfügung! Gibt den aktuellen Verzeichnis-Pfad auf dem FTP-Server zurück. Im Erfolgsfall liefert die @Function einen TEXT mit dem aktuellem Verzeihnis-Pfad zurück, sonst @Error …
@FTPNTGetFile
Holt das File mit dem Namen TEXT TEXTREMOTENAME aus aktuellen Verzeichnis auf dem FTP-Server der FTP-Session mit dem FTPNTHANDLE FTPNTHANDLE. TEXT TEXTREMOTENAME kann auch ein voll qualifizierter Pfad oder ein relativer …
@FTPNTGetLastError
Diese @Function steht nur unter Windows zur Verfügung! Gibt den letzten FehlerCode den eine zurück.
@FTPNTGetLastResponseInfo
Diese @Function steht nur unter Windows zur Verfügung! Gibt die letzte FTP-Server-Response zurück. Diese Function ist z.B. dann sinnvoll, wenn @FTPNTGetLastError den Code 12003 zurückgibt. In diesem Fall kann anhand der …
@FTPNTOpen
Diese @Function steht nur unter Windows zur Verfügung! Started eine FTP-Session. In TEXT APPLICATIONTEXT wird der Name der Application oder des Dienstes übergeben. (Dieser Name wird im ftp-Protokoll weitergegeben) FN FNC …
@FTPNTScanOSDirectory
Sucht im aktuellen Verzeichnis auf dem FTP-Server der FTP-Session mit dem FTPNTHANDLE FTPNTHANDLE nach darin enthaltenen Files ab. In TEXT TEXTPATTERN wird der FileName mit den Suchkriterien angegeben (WILDCARDS... z.b. …
@FTPNTSetCurrentDirectory
Diese @Function steht nur unter Windows zur Verfügung! Setzt den aktuellen Verzeichnis-Pfad auf dem FTP-Server. Im Erfolgsfall liefert die @Function einen TRUE zurück, sonst @Error.
@FtSearch
@FtSearch führt die eigentliche, über FTSEARCHHANDLE FTSEARCHHANDLE1 definierte, Suche durch. Mit dem Parameter FN FNLIMIT2 kann die Anzahl der gefundenen Dokumente limitiert werden. Wird hier 0 angegeben, werden alle Do …
@GetACL
Holt die ACL der Datenbank mit dem OSPATH OSPATH1 oder DBHANDLE DBHANDLE1 und gibt sie aufgeteilt auf TEXTLIST USERNAMES2, NUMBERLIST USERLEVEL3, TEXTLIST USERPRIVS4 und TEXTLIST PRIVNAMES5 zurück. USERNAMES2: Die ACL-Na …
@GetACLHistory
Es wird die ACL-(Veränderungs)-History der DB mit dem DBHANDLE DBHANDLE1 als TEXTLIST zurückgegeben. Beispiel @GetACLHistory(DBHANDLE1): DBHANDLE1:=@OpenDB("TEST.NSF"); @LogReport(@GetACLHistory(DBHANDLE1)); DBHANDLE1:=@ …
@GetACLMaxINetAccess
Gibt den Maximum Internet Access der DB mit dem DBHANDLE DBHANDLE1 zurück. LEVEL: 6=(Manager) Manager 5=(Developer) Entwickler 4=(Editor) Editor 3=(Author) Autor 2=(Reader) Leser 1=(Depositor) Archivar 0=(No …
@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 …