Engine Help: C
Gefilterte Übersicht der Engine-Help-Dokumentation.
@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 …
@Char
Wandelt den in FN/FNLIST FN1/FNLIST1 angegebenen ASCII-Code in das entsprechende Zeichen, bzw. eine Liste von Zeichen um.
@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 …
@ClearFolder
Diese @Function entfernt alle Dokumente, in der DB mit dem DBHANDLE DBHANDLE1, aus dem Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2. (Die Dokumente werden nur aus dem Folder entfernt und nicht aus der DB gelöscht.) Return …
@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.
@CloseAgent
Schließt den Agent(Filter) mit dem AGENTHANDLE AGENTHANDLE1 und gibt den geschlossenen AGENTHANDLE zurück.
@CloseAttachedFile
Schließt das File-Attachment mit dem OBJECTFILEHANDLE OBJECTFILEHANDLE1 und gibt den geschlossenen OBJECTFILEHANDLE zurück. Beipiel: @CloseAttachedFile(OBJECTFILEHANDLE1) DBHANDLE1:=@OpenDB("TESTDB\\TESTDB1.NSF"); NOTEID …
@CloseDB
Schließt eine vorher geöffnete Datenbank mit dem DBHANDLE DBHANDLE1 und gibt den geschlossenen DBHANDLE1 zurück. Ab der Version 1.93 kann mit TEXT OPTIONS2 ein näheres bzw. zusätzliches Verhalten bestimmt werden. OPTIONS …
@CloseFtSearch
Schließt einen vorher geöffneten Full-Text-Search mit dem FTSEARCHHANDLE FTSEARCHHANDLE1 und gibt den geschlossenen FTSEARCHHANDLE1 zurück.
@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 …
@CloseNote
Schließt das Dokument mit dem NOTEHANDLE NOTEHANDLE1 und gibt den geschlossenen NOTEHANDLE zurück. Mit FN MODE2 kann ein näheres Verhalten bestimmt werden. MODE2: 0 = Keine Änderungen speichern. 1 = Änderungen speichern. …
@CloseNTComPort
Nur für Engine unter Windows! Schließt das Device mit dem OSCOMHANDLE OSCOMHANDLE1 und gibt den geschlossenen OSCOMHANDLE zurück. Beipiel: @CloseNTComPort(OSCOMHANDLE1) OSCOMHANDLE1:=@OpenNTComPort("COM1"); OSCOMHANDLE1: …
@CloseOSComPort
Schließt das Device mit dem OSCOMHANDLE OSCOMHANDLE1 und gibt den geschlossenen OSCOMHANDLE zurück. Beipiel: @CloseOSComPort(OSCOMHANDLE1) OSCOMHANDLE1:=@OpenOSComPort("COM1"); OSCOMHANDLE1:=@CloseOSComPort(OSCOMHANDLE1) …
@CloseOSFile
Schließt das OSFILE mit dem FILEHANDLE FILEHANDLE1 und gibt den geschlossenen FILEHANDLE zurück. Beipiel: @CloseOSFile(FILEHANDLE1) FILEHANDLE1:=@OpenOSFile("C:\\TEST.TXT";"R"); FILEHANDLE1:=@CloseOSFile(FILEHANDLE1); Di …
@CloseQueue
Schließt die Message-Queue mit dem Queue-Handle VSPECQUEUEHANDLE QUEUEHANDLE. Im Erfolgsfall wird TRUE zurückgegeben, andernfalls @ERROR.
@CloseView
Schließt die Ansicht mit dem VIEWHANDLE VIEWHANDLE1 und gibt den geschlossenen VIEWHANDLE zurück.
@CompactDB
Die DB mit dem NOTESPATH NOTESPATH1 wird kompaktiert. FNOPTIONS: BIT DEC HEX BEDEUTUNG 01 00001 0001 02 00002 0002 03 00004 0004 04 00008 0008 05 00016 0010 06 00032 0020 07 …
@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 …
@CompileFormula
Compiliert TEXT1 einen Notes-Formel-Text in das Notes-Formel-Compilat (CNFORMULA) und gibt dieses zurück. TEXT2 wird für Column-Formulas benötigt und muß den Column-Item-Name enthalten. Beispiel @CompileFormula(TEXT1): C …
@Contains
Ermittelt ob im TEXT/TEXTLIST TEXT1/TEXTLIST1 der TEXT TEXT2 oder ein Element der TEXTLIST TEXTLIST2 ganz oder teilweise enthalten ist und gibt TRUE zurück wenn dies der Fall ist. Eine Ausnahme bildet eine leere TEXTLIST …
@CopyACL
Kopiert die ACL der Datenbank mit dem DBHANDLE DBHANDLE1 in die Datenbank mit dem DBHANDLE DBHANDLE2. Wenn die @Funktion erfolgreich durchgeführt wurde, ist das @Funktions-Ergebnis vom Datentyp PV. Der durchführende Serv …
@CopyAttachment
Kopiert Attachments aus dem geöffneten Dokument mit dem NOTEHANDLE NOTEHANDLE3 der Datenbank DBHANDLE DBHANDLE1 in das ebenfalls geöffnete Dokument NOTEHANDLE NOTEHANDLE4 der Datenbank DBHANDLE DBHANDLE2, ohne Überschnei …
@CopyDB
Kopiert die Datenbank mit dem DBHANDLE DBHANDLE4 auf eine Datenbank mit dem NOTESPATH NOTHESPATH1 und der DBCLASS DBCLASS2 und gibt einen DBHANDLE auf diese zurück. Es werden die Dokumente die der Angabe in NOTECLASSES N …
@CopyFolder
Diese @Function kopiert, in der DB mit dem DBHANDLE DBHANDLE1, den Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2 als Folder mit dem Namen TEXT NEWFOLDERNAME3. (Es werden alle Dokumente, Subfolder und das Design kopiert.) R …
@CopyNote
Kopiert das Dokument mit dem NOTEHANDLE NOTEHANDLE2 in die Datenbank mit dem DBHANDLE DBHANDLE1 und gibt den NOTEHANDLE auf dieses neue Dokument zurück. NOTEHANDLE3 ist der NOTEHANDLE des neuen Dokuments.
@CopyTemplateACL
Kopiert die Template-ACL der Datenbank mit dem DBHANDLE DBHANDLE1 als ACL in die Datenbank mit dem DBHANDLE DBHANDLE2. Template-ACL-Einträge werden in der ACL in eckigen Klammern angegeben. Diese @Funktion setzt diese Ei …
@CopyVStack
Diese @Funktion kopiert alle Variablen des VStack mit dem VSTACKPATH TEXTSOURCEVSTACK auf den VStack mit dem VSTACKPATH TEXTDESTINATIONVSTACK. Wird der Parameter TEXT/TEXTLIST TEXTLISTVARNAMES angegeben, werden nur die V …
@Cos
Berechnet den Cosinus von FN/FNLIST FN1/FNLIST1.
@CountListElement
Addiert zu der TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 an der FN POSITION2 das Element TEXT/FN TEXT3/FN3 dazu. Im Fall von TEXT1/FN1 ist als einzig gültige POSITION2 die 1 möglich. Es können nur Elemente pass …
@CreateAttachmentFromBuffer
Erzeugt aus dem Inhalt des BINBUFFER BINBUFFER ein Attachment mit dem (internem) Namen TEXT TEXTNAME in dem Dokument mit dem NOTEHANDLE NOTEHANDLE. FN FNOPTIONS: 0 Keine 1 Überschreibe ein möglicherweise vorhandenes …
@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 …
@Created
Gibt den Zeit/Datums-Wert (TD) der Erstellung des Dokuments mit dem NOTEHANDLE NOTEHANDLE1 zurück.
@CreateDB
Legt eine neue absolut leere Datenbank der DBCLASS DBCLASS2 unter dem NOTESPATH NOTESPATH1 an und gibt einen DBHANDLE auf diese zurück. Mit FN OVERWRITE3 kann festgelegt werden, ob eine evtl. bestehende Datenbank gleiche …
@CreateDBActivity
Startet die Protokolierung der User-Activity der Datenbank mit dem DBHANDLE DBHANDLE1. Wird NUMBER 1 zurückgegeben war die Operation erfolgreich (oder schon eine User-Activity vorhanden) sonst ERROR.
@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 …
@CreateNote
Erstellt ein neues Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 zu dem NOTEHANDLE NOTEHANDLE2 und gibt den NOTEHANDLE darauf zurück.
@CreateObjectStore
Erzeugt eine neue Notes-Object-Store-Datenbank mit dem NOTESPATH NOTESPATH1. Mit dem Parameter FN BOOLOVERWRITE2 wird festgelegt, ob eine bereits existierende Notes-Object-Store-Datenbank mit diesem NOTESPATH NOTESPATH1 …
@CreateOSDirectory
Syntax 1: Erstellt ein Verzeichnis mit dem OSPATH OSPATH1. Syntax 2: Erstellt die Verzeichnisse die in der OSPATHLIST OSPATHLIST1 angegeben sind.
@CreateQueue
Erzeugt eine Message-Queue mit dem Namen TEXT TEXTQUEUENAME. Im Erfolgsfall wird TRUE zurückgegeben, andernfalls @ERROR. Eine Message-Queue wird zur Inter-Task-Kommunikation verwendet. Die Message-Queue kann von mehreren …
@CreateQuietTask
Erzeugt eine Neuen Engine-Task der die GLOBALe Funktion mit dem Namen TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME ausführt. Wenn @CreateQuietTask mit einer TEXTLIST als ersten Parameter aufgerufen wir …
@CreateQuietTaskNoWait
Erzeugt eine Neuen Engine-Task der die GLOBALe Funktion mit dem Namen TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME ausführt. Wenn @CreateQuietTask mit einer TEXTLIST als ersten Parameter aufgerufen wir …
@CreateTask
Erzeugt eine Neuen Engine-Task der die GLOBALe Funktion mit dem Namen TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME ausführt. Wenn @CreateTask mit einer TEXTLIST als ersten Parameter aufgerufen wird, mu …
@CutList
TEXT TEXT2 wird in die in FN/FNLIST FN1/FNLIST1 angegebenen Längen zerschnitten und als TEXTLIST zurückgegeben. Bei Angabe von TEXTLIST TEXTLIST3 wird bei einer 0 (NULL) in FN/FNLIST FN1/FNLIST1 das korrespondierende Ele …