Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@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 …
@GetDBActivity
Holt das User-Activity-Protokoll der Datenbank mit dem DBHANDLE1. Das @Funktions-Ergebnis ist 1 für kein Fehler oder @ERROR. Die letzten vier Argumente der @Funktion sind Return-Parameter: In RETTDLIST2 werden die Zeiten …
@GetDBARConnection
Gibt, zu der DB mit dem DBHANDLE DBHANDLE1, die Einstellungen der Advanced Replication Connection vom Quellserver TEXT SOURCESERVER zum Zielserver TEXT DESTINATIONSERVER zurück, wenn es eine Definition für dieses Zielser …
@GetDBARConnections
Es wird in TEXTLIST TLRETDESTINATIONSERVERS die Liste der Zielserver zurückgegeben, für die in der DB mit dem DBHANDLE DBHANDLE1, Advanced Replication Settings definiert wurden. Optional kann im Parameter TEXTLIST TLRETS …
@GetDBCurrentAccess
Es wird zur DB mit dem DBHANDLE DBHANDLE1 der aktuelle Access-Level (zur Ausführungszeit des Aufrufs) und optional die aktuell geltenden Flags (NUMBER NRETFLAGS) zurückgegeben. Im Fehlerfall wird @Error zurückgegeben. US …
@GetDBDocumentCount
Es wird die Anzahl der Data-Dokumente der DB mit dem DBHANDLE DBHANDLE1 in zurückgegeben. Optional kann die Anzahl der gelöschten Dokumente FLOAT FLOATDELETEDCOUNT und die Anzahl der Design-Dokumente FLOAT FLOATDESIGNCOU …
@GetDBID
Es wird die ID der DB mit dem DBHANDLE DBHANDLE1 in zurückgegeben. Die ID ist ein TD Wert der den Zeitpunkt der Erzeugung der DB angibt.
@GetDBLaunchOptions
Gibt die Launch-DB-Optionen der DB mit dem DBHANDLE DBHANDLE1 als BitVektor(FN) zurück. In TEXTLIST TEXTLIST1 werden die Namen der Navigatoren bzw. der View zurückgegeben. In RID RID1 wird die RID der DB zurückgegeben (w …
@GetDBModified
Gibt zurück, wann die Datenbank mit dem DBHANDLE DBHANDLE1 zum letzten mal geändert wurde. Dabei steht im Rückgabewert (TD) die letzte Änderung eines Daten-Dokumentes und in TD TD1 die letzte Änderung eines Nicht-Daten-D …
@GetDBObjectStoreID
Gibt die Replika-ID (RID/DBID) der Notes-Object-Store-Datenbank zurück, die mit der Datenbank mit dem DBHANDLE DBHANDLE assoziiert ist. Im Fehlerfall wird @ERROR zurückgegeben.
@GetDBOptions
Gibt die DB-Optionen der DB mit dem DBHANDLE DBHANDLE1 als BitVektor(FN) zurück. In FN FNEXTOPTIONS werden die erweiterten Optionen der DB zurückgegeben. FNEXTOPTIONS: BIT DEC HEX BEDEUTUNG wenn gesetzt 01 000001 …
@GetDBPath
Gibt den OSPATH und den NOTESPATH der Datenbank mit dem DBHANDLE DBHANDLE1 in einer TEXTLIST zurück. Wenn die Datenbank unter Angabe eines Servers (z.B. "TEST_SERVER!!TEST.NSF") geöffnet wurde, sind beide Elemente identi …
@GetDBQuota
Gibt die DB-Quota der DB mit dem DBHANDLE DBHANDLE1 als FLOATLIST mit 4 Elementen zurück. Element Nr. Bedeutung 1 Maxium size in kB of the database 2 Actual size in kB of the database 3 Quota in kB of the databas …
@GetDBReplicaHistory
Holt die Replikations-History der Datenbank mit dem DBHANDLE DBHANDLE1. Direkt zurückgegeben wird eine TEXTLIST mit den Namen der Server/User. In RETTD1 wird eine TDLIST mit jeweils dem letzten Replikationsdatum, korresp …
@GetDBReplicaInfo
Holt die Replikations-Information über Replik-ID TD REPLICAID2, Replikations-Flags NUMBER FLAGS3, Replikations-Lösch-Intervall NUMBER CUTOFFINTERVAL4 und Replikations-Lösch-Zeitpunkt TD CUTOFFTD5 der Datenbank mit dem DB …
@GetDBSpaceUsage
Es wird die Größe der DB mit dem DBHANDLE DBHANDLE1 in Bytes zurückgegeben (aufgerundet auf volle MBytes). Optional kann die Anzahl der benutzten (FLOAT FLOATALLOC) bzw. der freien Bytes (FLOAT FLOATFREE) sowie die proze …
@GetDBTitle
Gibt den Datenbanktitel und die Datenbank-Kategorien der Datenbank mit dem DBHANDLE DBHANDLE1 zurück. Der Rückgabe-Wert ist vom Typ TEXTLIST bei der im ersten Element der Titel steht und für jede vorhandene Kategorie ein …
@GetDBVersion
Gibt die FN Major-Version (ODS-Version) der Datenbank mit dem DBHANDLE DBHANDLE1 zurück. Im optionalem Parameter FNRETMINVERSION wird die Minor-Version der Datenbank zurückgegeben.
@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
@GetDocPrivileges
Gibt eine FLOATLIST der zu dem Dokument mit dem NOTEHANDLE NOTEHANDLE1 gehörenden Privilegien zurück. Hat das Dokument keine Privilegien so hat die Liste 0 Elemente.
@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.
@GetFieldComponents
Gibt die Komponenten einer VSPECDNFIELD DNFIELD1 Variable - also eines Feldes in einer Maske - zurück. Die Parameter PARAMETER2, PARAMETER3, PARAMETER4 und PARAMETER5 sind reserviert, TEXTLIST KEYWORDS6 enthält die evtl. …
@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 …
@GetFolderCount
Diese @Function gibt die Anzahl der Dokumente zurück, die sich in der DB, mit dem DBHANDLE DBHANDLE1 in dem Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2, befinden. ReturnWert: Wurde die @Function erfolgreich durchgeführt …
@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 …
@GetLastNotesErrorCode
Gibt den Notes-Error Code der letzten Notes-Funktion dieses Tasks als FN zurück. (Kann also auch NOERROR=0 sein.) Siehe auch @GetNotesErrorString.
@GetLinkListProperties
Gibt die Eigenschaften des Dokumenten-Links an der Position FN POSITION2 aus der VSPECLINKLIST DOCLINKLIST1 zurück. TD RETTDRID3 ist die Replik-ID der DB auf die der Dokumenten-Link verweist. (Steht hier @AnyAllDay verwe …
@GetListElement
Gibt das Element an FN/FNLIST POSITION2/POSITIONLIST2 von FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/ID/IDLIST/HUGETEXTLIST/UNIDLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/ID1/IDLIST1/HUGETEXTLIST1/UNIDLIST1 zurück, wobei im Fal …
@GetMailAddress
Gibt die Mailadresse oder, wenn eingetragen, die Mailadresse zur Weiterleitung zum User TEXT USER1 (aus dem Adreßbuch) zurück.
@GetMailLocation
Gibt die Mail relevanten Informationen zu dem User TEXT (aus dem Adressbuch) zurück. Als ReturnWert wird der MailServer (TEXT) zurückgegeben. In P2 wird der MailFileName (TEXT) zurückgegeben.
@GetNoteClass
Gibt die NOTECLASS (siehe NOTECLASSES) des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück. FN NOTECLASS: DEC BIT Bedeutung 00000 XX No Notes keine Dokumente 00001 01 Documents Daten-Dokumente 00002 02 …
@GetNoteDB
Holt den DBHANDLE DBHANDLE1 aus dem Dokument mit dem NOTEHANDLE NOTEHANDLE1. Zurückgegeben wird der DBHANDLE1 des Dokumentes oder ein ERROR.
@GetNoteFieldByID
Öffnet die Dokumente in der Datenbank mit dem DBHANDLE DBHANDLE1 und den FLOATLIST/IDLIST IDLIST2 und gibt eine TEXTLIST mit dem Inhalten des TEXT Feldes mit dem Namen TEXT TEXTFIELDNAME3 zurück. Über den Optionalen Para …
@GetNoteID
Gibt die NoteID (ID) des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück. HINWEIS: Nur Dokumente, die aus einer Datenbank geöffnet wurden, haben eine NoteID. Beipiel: @GetNoteID(NOTEHANDLE1) DBHANDLE:=@OpenDB("TEST.NSF") …
@GetNoteIDsByPosition
Holt in der Ansicht mit dem VIEWHANDLE VIEWHANDLE1 ab der Position VIEWPOSITION/VIEWPOS VIEWPOSITION2 die NoteIDs und gibt sie als IDLIST zurück. In der Position 10 der VIEWPOSITION/VIEWPOS VIEWPOSITION2 wird die Anzahl …
@GetNoteIDsFromView
Die NoteID's der Dokumente in der Ansicht zu dem VIEWHANDLE VIEWHANDLE1 werden, ab der VIEWPOSITION/VIEWPOS VIEWPOSITION2, als IDList zurückgegeben. VIEWPOSITION2 ist eine FNLIST mit 10 Einträgen. Im 1.Eintrag steht die …
@GetNoteOID
Gibt die OID des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@GetNotesErrorString
Gibt zu einem Notes-Error-Status-Code (FN1) den dazugehörigen Fehlermeldungs-Text zurück.
@GetNoteUID
Gibt die UID des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@GetNTComPortEventMask
Nur für Engine unter Windows! Aktuelle Event-Mask für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 abfragen und zurückliefern. Return-Wert: Bit HEX C-Symbol Bedeutung 1 0001 EV_RXCHAR A character was received and …
@GetNTComPortHandshake
Nur für Engine unter Windows! Aktuelle Handshake-Einstellung für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 abfragen und zurückliefern. FN RTS2: (Ready-to-send) Wert C-Symbol Bedeutung 0 RTS_CONTROL_DISABLE D …
@GetNTComPortInQueCount
Nur für Engine unter Windows! Gibt die Anzahl der Bytes zurück die zum Zeitpunkt des Aufrufs zur Abholung mit @ReadNTComPort bereit standen.
@GetNTComPortModemStatus
Nur für Engine unter Windows! Aktuellen Status eines Modems am COM-Port mit OSCOMHANDLE OSCOMHANDLE1 abfragen und zurückliefern. Return-Wert: Bit HEX C-Symbol Bedeutung 5 0010 MS_CTS_ON The CTS-line …
@GetNTComPortOutQueCount
Nur für Engine unter Windows! Gibt die Anzahl der Bytes zurück die zum Zeitpunkt des Aufrufs noch im Sendebuffer zur Übertragung bereitstehen.
@GetNTComPortProperties
Nur für Engine unter Windows! Aktuelle Einstellungsmöglichkeiten für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 abfragen und zurückliefern. Alle zurückgegebenen Werte sind bitweise codiert und entsprechend der Möglichkeiten g …
@GetNTComPortSettings
Nur für Engine unter Windows! Aktuelle Einstellungen für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 abfragen und zurückliefern. BAUD2: (Baudrate) 300 ... 128k DATA3: (Anzahl der Datenbits) 5 6 7 8 STOP4: (Anzahl der Stopbits) …