Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@GetNTComPortTimeouts
Nur für Engine unter Windows! Aktuelle Timeout-Einstellungen für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 abfragen und zurückliefern. Mit Außnahme von FN RDINT2 werden mit allen angegebenen Werten Timeouts spezifiziert, die …
@GetOIDComponents
Gibt die Komponenten der OID OID in TD RETTDDBID, TD RETTDNOTE, TD RETTDINSTANCETD und FLOAT RETFLOATINSTANCENUMBER zurück. TD RETTDDBID ist die Datenbank ID der Dantenbank, in der das Dokument erstellt wurde. TD RETTDNO …
@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.
@GetOSComPortEvent
Gibt zurück welche Events seit dem letzten Aufruf mit dem selben OSCOMHANDLE OSCOMHANDLE1 aufgetretten sind. Events: Bit Decimal Hex EVENT 1 1 1 Char empfangem 2 2 2 ReceiveTimeoutInterrupt (WIRD VON …
@GetOSComPortInfo
Gibt die Einstellungen des COMPORTS mit dem COSCOMPORTHANDLE COSCOMPORTHANDLE1 zurück. FNWRTO1: Write TimeOut (angaben ?? regulär 6000) Unter NT ist das WriteTotalTimeoutConstant. Siehe http://msdn2.microsoft.com/en-us/l …
@GetOSComPortInQueCount
Gibt die Anzahl der Bytes zurück die zum Zeitpunkt des Aufrufs von @GetOSComPortInQueCount zur Abholung mit @ReadOSComPort bereit standen.
@GetOSComPortLineInfo
Gibt die PortInfo zu einem OSCOMPORT (Device) zurück. FNDATA1: Data Bits 7 oder 8 FNPARITY1: Parity Bits (unklar) 0 =1 Bit 2 =2 Bit ??? FNSTOP1: Stop Bits (unklar) 0 =1 Bit 2 =2 Bit ??? FNTBREAK1 (TransBreak): Unklar ??? …
@GetOSComPortOutQueCount
Gibt die Anzahl der Bytes zurück die zum Zeitpunkt des Aufrufs von @GetOSComPortOutQueCount zur Übertragung (an das entfernte System) im OSCOM-Puffer anstehen.
@GetOSComPortSpeed
Gibt die an dem OSCOMPORT verwendete Baud-Rate zurück.
@GetOSComPortStatus
Gibt den Status des OSCOM-PORT zurück. Bit Bedeutung 1 TX_WAITING_FOR_CTS 2 TX_WAITING_FOR_DSR 3 TX_WAITING_FOR_DCD 4 TX_WAITING_FOR_XON 5 …
@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 …
@GetOSPath
Gibt den physikalischen/lokalen Pfad (OSPATH) zum relativen NOTESPATH/NOTESPATHLIST NOTESPATH1/NOTESPATHLIST1 zurück. Directory- und Datenbank-Verbindungen werden dabei berücksichtigt. Wird eine NOTESPATHLIST als Input-P …
@GetPictureFileInfo
Gibt Informationen über den Inhalt einer Bild-Datei (eines Bildes innerhalb einer Bild-Datei) zurück. FILEHANDLE PICFILEHANDLE: FILEHANDLE auf eine im Binär-Modus geöffnete Bild-Datei. FN FILETYPE: 1=TIFF File monochrom …
@GetPosAttachedFile
Gibt die aktuelle Position im File-Attachment mit dem OBJECTFILEHANDLE OBJECTFILEHANDLE1 zurück.
@GetPosOSFile
Gibt die aktuelle Position im OSFILE mit dem FILEHANDLE FILEHANDLE1 zurück.
@GetProfileField
Gibt den Inhalt des Profile-Feld's, mit dem Namen TEXT TEXTFIELDNAME, für den Benutzer mit dem Namen TEXT TEXTUSERNAME (kann auch "" sein), unter Berücksichtigung der Profile-Form mit dem Namen TEXT TEXTPROFILEFORMNAME a …
@GetQueue
Holt die nächste Message der Message-Queue mit dem Queue-Handle VSPECQUEUEHANDLE QUEUEHANDLE. Im Erfolgsfall wird die Message (TEXT) zurückgegeben, andernfalls @ERROR (nur ein Parameter Version, andernfalls "" (NULLSTRIN …
@GetRemoteDBPathByRID
Es wird auf dem Server mit dem ServerName TEXT TEXTSERVERNAME die erste DB mit der ReplikID RID DBRID gesucht und der NotesPath (TEXT) auf diese zurückgegeben. Mit diesem NotesPath kann die gefundene DB geöffnet werden. …
@GetSchedListEntry
Gibt die Daten für einen bestimmten Eintrag FN POSITION2 der SCHEDLIST SCHEDLIST1 zurück. In UID UID3 wird die UID des documents zurückgegben auf das sich dieser Eintrag bezieht. In TDLIST TDLRANGE4 wird die Zeitspanne d …
@GetServerStats
Holt die Statistics Einträge des Servers TEXT TEXT1 und gibt diese als TEXTLIST zurück. Mit dem optionalem Parameter TEXT TEXT2 kann die Facility eingegrenzt werden, so daß nur noch Einträge aus diesem Bereich zurückgege …
@GetSessionID
Gibt eine neue SessionID zurück.
@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 …
@GetThreadID
Gibt die ThreadID (FN) des Thread's zurück dessen Skript diese @Function ausführt.. Der optionale Parameter FN FNTYPEOFTASKID bestimmt ob die ThreadID des Betriebssystems oder die Engine-Interne TaskID (wird z.B. bei "sh …
@GetThreadIDText
Gibt die ThreadID des Thread's als TEXT zurück dessen Skript diese @Function ausführt.
@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.
@GetVar
Gibt den Wert der Variablen mit dem Namen TEXT NAME1 zurück. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 angegeben werden. Hiermi …
@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 …
@GetVarWithFieldFlags
Gibt den Wert der Variablen mit dem Namen TEXT NAME1 zurück. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 angegeben werden. Hiermi …
@GetViewPosInfo
Gibt die Informationen zu der VIEWPOS VIEWPOS zurück. Der Return-Wert der @Function liefert die Anzahl der gefundenen Dokument (z.B. durch die @Function @FindDocumentsByKey oder @FindCategoryByName) zurück. Im optionalen …
@GetVStackPath2GFun
Liefert den Prefix für den Zugriffspfad einer Variable, die innerhalb der Thread-Kopie einer globalen Funktion gespeichert ist. Hiermit könnten z.B. Default-Werte für lokalen Parameter belegt werden. Nach Möglichkeit sol …
@HashPassword
Generiert aus dem TEXT TEXTPASSWORD1 einen Hash, der als TEXT zurückgegeben wird. Im Fehlerfall liefert @HashPassword @Error zurückgegeben. Diese @Function erzeugt einen Hash, der kompatibel ist zu einem mit Typ 2 (FN FN …
@HexDumpToBin
@HexDumpToBin wandelt den Hex-Stream-Dump in TEXT/BINBUFFER VAR1 in einen binären Buffer um. Whitespace wird dabei ignoriert! Über TEXT TEXTRETTYPE2 kann bestimmt werden, ob die zurück gegebenen Binärdaten als RT oder al …
@HookUpdateFields
Mit dieser @Funktion werden, durch das Engine-Script der gloablen HOOK-Funktion, geänderte Felder, des Dokuments mit dem NOTEHANDLE NOTEHANDLE1, zurück in das Dokument transferiert.
@Hour
Gibt die Stunden von TD/TDLIST TD1/TDLIST1 zurück. Wird die @Function mit dem Parameter TEXTOPTIONS aufgerufen, bestimmt dieser den Rückgabetyp. TEXT TEXTOPTIONS F=default (Rückgabe-Datentyp = FLOAT/FLOATLIST) A=Rückgabe …
@HttpExtractFields
Die http POST Fields in TEXT TEXT1 werden als Engine-Variable auf den VStack TEXT VSTACKPATH2 abgelegt. Im Erfolgs-Fall wird TRUE zurückgegeben, andernfalls @ERROR.
@HTTPGet
Derzeit nur für Windows verfügbar!!! Liefert den HTML-Code einer WWW-Seite als TEXT zurück. Neben TEXT SERVER1 und TEXT PAGE2 kann optional eine Portnummer FN PORT3 bestimmt werden. Ohne Angabe wird standardmäßig 80 verw …
@HTTPSGet
Derzeit nur für Windows verfügbar!!! Liefert den HTML-Code einer WWW-Seite als TEXT zurück. Neben TEXT SERVER1 und TEXT PAGE2 kann optional eine Portnummer FN/TEXT PORT3 bestimmt werden. Ohne Angabe wird standardmäßig 44 …
@HugeTextList
Gibt eine Variable vom Typ HUGETEXTLIST mit 0 Elementen zurück.
@IDList
Gibt eine Variable vom Typ IDLIST mit 0 Elementen zurück.