Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@ReadNTComPort
Nur für Engine unter Windows! Lesen eines Wertes von dem COM-Port mit dem OSCOMHANDLE OSCOMHANDLE1 und zurückgeben als @Funktionsergebnis. Der gelesene Wert soll vom Typ TEXT RETTYPE2 sein. Gelesen wird entweder 1 Wert ( …
@ReadOSComPort
RETTYPE2: A=TEXT B=BINARY (derzeit als RICHTEXT) N=NUMBER F=FLOAT L=FLOAT (konvertierter long) D=FLOAT (konvertiertes DWORD) T=TIMEDATE STATUS4: 0=OK 1=Read Timeout expired 2=TEXT limit reached (nur im TEXT Modus) 32768= …
@ReadOSFile
Liest aus dem OSFILE mit dem FILEHANDLE FILEHANDLE1 einen Satz mit der Länge FN LENGTH3. Dieser Satz wird als Variable des Datentyp's, der in TEXT RETTYPE2 spezifiziert wird, zurückgegeben. Wird TEXT/TEXTLIST TEXT3/TEXTL …
@ReadVarOSFile
Liest aus dem OSFILE mit dem FILEHANDLE FILEHANDLE1 eine Variable (die mit @WriteVarOSFile geschrieben wurde) und gibt diese zurück. Der Inhalt einer Variable, sowie deren Namen etc. kann direkt in ein File geschrieben u …
@RecalculateNote
NOTEHANDLE NOTEHANDLE1 Dokument, für das die Neuberechnung ausgeführt werden soll. NOTEHANDLE NOTEHANDLE2 Form-Design-Dokument, das die Formeln und Felder enthält. NF FLAGS3 0 Fehler melden 1 Bei Fehlern fortfahren Retur …
@ReleaseClass
Es wird (werden) die Class(es) mit dem (den) Namen TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1 freigegeben. Returnwert: @Error -> Ein Fehler ist aufgetretten. TRUE -> Alle angeforderten Classes freigegeben. FALSE …
@ReleaseMutexSemaphore
Gibt die Mutex-Semaphore mit dem Mutex-Semaphore-Handle (MSH) MUTEXSEMAPHOREHANDLE wieder frei. Im Erfolgsfall wird @True zurückgegeben, andernfalls @ERROR. Eine Mutex-Semaphore kann nur von einem Task zu einem Zeitpunkt …
@RemoteConsole
Führt auf der Remote-Console des TEXT SERVER1 das Kommando TEXT COMMAND2 aus. Im Erfolgsfall wird als Ergebnis ein TEXT zurückgegeben, ansonsten ein @ERROR mit dem Fehlertext.
@RenameFolder
Diese @Function gibt dem Folder, in der DB mit dem DBHANDLE DBHANDLE1 und dem VIEWHANDLE VIEWHANDLEFOLDER2, den Namen TEXT NEWFOLDERNAME3. ReturnWert: Wurde die @Function erfolgreich durchgeführt wird TRUE zurückgegeben, …
@ReorgACLPrivileges
Die leeren Elemente der TEXTLIST PRIVNAMES2 werden entfernt und im Parameter RETUSERPRIVS3 zurückgegeben. Die korrespondierenden Privilegienverweise in der TEXTLIST USERPRIVS1 werden angepaßt und im Parameter RETPRIVNAME …
@ReorgList
Diese @Funktion bringt die Elemente einer Liste in eine neue Reihenfolge und gibt diese neue Liste zurück. TEXTLIST/FNLIST/TDLIST LIST1 ist die Liste deren Elemente in eine neue Reihenfolge gebracht werden sollen. FNLIST …
@Repeat
Wiederholt den Text in TEXT TEXT1 bzw. in jedem Element von TEXTLIST TEXTLIST1 bis die Anzahl FN COUNT2 erreicht ist und schneidet die entstandenen Texte evtl. nach FN LENGTH3 Stellen ab.
@Replace
Ersetzt in TEXT/TEXTLIST TEXT1/TEXTLIST1 alle Elemente TEXT/TEXTLIST TEXT2/TEXTLIST2 durch TEXT/TEXTLIST TEXT3/TEXTLIST3. Es wird also in TEXT2/TEXTLIST2 eine Liste von Textstücken angegeben, die durch Textstücke aus TEX …
@ReplaceSubString
Ersetzt in TEXT/TEXTLIST TEXT1/TEXTLIST1 die in TEXT/TEXTLIST TEXT2/TEXTLIST2 angegebenen Strings durch das korrespondierende Element aus TEXT/TEXTLIST TEXT3/TEXTLIST3. Der optionale Parameter FN FNCMPMODE bestimmt den S …
@Replicate
Repliziert die Datenbank mit dem DBHANDLE DBHANDLE1 mit der Datenbank mit dem DBHANDLE DBHANDLE2. FNLIST FNLIST3 ist eine Liste mit Rechten bei der das erste Element die Rechte der Replizierung in der ersten Datenbank an …
@ReplicateWithFormula
Repliziert die Datenbank mit dem DBHANDLE DBHANDLE1 mit der Datenbank mit dem DBHANDLE DBHANDLE2, wobei nur die Dokumente repliziert werden, die der Notes-Kompatiblen Selection-Formula TEXT/TEXTLIST FORMULA3 entsprechen. …
@ReplicateWithFormulaWithFieldException
Repliziert die Datenbank mit dem DBHANDLE DBHANDLE1 mit der Datenbank mit dem DBHANDLE DBHANDLE2, wobei nur die Dokumente repliziert werden, die der Notes-Kompatiblen Selection-Formula TEXT FORMULA3 entsprechen. FNLIST F …
@ReplicateWithServer
Es die Datenbanken des lokalen Notes-Servers mit dem entfernten Notes-Server TEXT SERVERNAME2 über den Port TEXT PORTNAME1 durch den Notes-Replikator (nicht der Engine-Replikator) repliziert. Über FN OPTIONS3 können Opti …
@RequestClass
Es wird (werden) die Class(es) mit dem (den) Namen TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1 angefordert. Returnwert: @Error -> Ein Fehler ist aufgetretten. TRUE -> Alle angeforderten Classes erhalten. FALSE -> …
@RequestMutexSemaphore
Verlangt und belegt (im Erfolgsfall) die Mutex-Semaphore mit dem Mutex-Semaphore-Handle (MSH) MUTEXSEMAPHOREHANDLE. Im Erfolgsfall wird @True zurückgegeben, andernfalls @ERROR. Wird FN FNTIMEOUT mit angegeben wird nach F …
@ResetVStack
Setzt alle Variablen auf dem VStack mit dem Namen TEXT NAME1 auf den Wert in VAR1 zurück.Wird die @Funktion in der Syntax ohne zweiten Parameter angegeben, werden die Variablen auf den Wert/Datentyp PV gesetzt. Sub-VStac …
@Reverse
Dreht die Reihenfolge der Buchstaben in TEXT TEXT1 oder in jedem Element von TEXTLIST TEXTLIST1 um.
@Right
Gibt den rechten Teil von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können FN COUNT2 Zeichen oder der rechts von TEXT TEXT2 stehende Text. Die Suche nach TEXT2 geschieht dabei von links nach rechts.
@RightBack
Gibt den rechten Teil von TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück. Ausgewählt werden können alle Zeichen bis auf FN COUNT2 verbleibende oder der rechts von TEXT TEXT2 stehende Text. Die Suche nach TEXT2 geschieht dabei von …
@RTAddButton
Fügt einen Button mit der Aufschrift TEXT TEXT1 und der CNFORMULA CNFORMULA4 an das RichText-Feld RT RT5 an. FNLIST STYLE2: 1. StyleDefinitionNumber 2. Schriftart 3. Größe 4. Optionen 5. Color 1. StyleDefinitio …
@RTAddDocLink
Fügt eine Dokumentenverbindung (DocLink) auf das Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 aus der Ansicht mit dem VIEWHANDLE VIEWHANDLE2 und dem NOTEHANDLE NOTEHANDLE3 in das Richtext-Feld RT RTFIELD4 ein. De …
@RTAddFileIcon
Fügt ein File-Icon im OS/2-Style an das RichText-Feld RT RT4 an. TEXT1: Zur Anzeige und zur Referenz innerhalb des Notes-Dokumentes bestimmter Name des File-Attachments, dieser Name muß eindeutig sein. TEXT2: Orginal Nam …
@RTAddHotSpotTextDocLink
Fügt eine Dokumentenverbindung (DocLink) auf das Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 aus der Ansicht mit dem VIEWHANDLE VIEWHANDLE2 und dem NOTEHANDLE NOTEHANDLE3 in das Richtext-Feld RT RTFIELD4 ein. De …
@RTAddParagraph
Fügt der HRT (HUGERICHTEXT) Variable HRT2 den RICHTEXT Paragraphen (abgeschlossene RICHTEXT-Portion) RT1 an. Ein Richtext-Feld besteht aus vielen einzelnen Paragraphen die Elemente des RICHTEXT-Feldes Beschreiben. z.B. e …
@RTAddPictureFile
Diese Funktion addiert zu dem HRT Feld HRT3 den Inhalt der Bild-Datei mit dem FH (FILEHANDLE) PICFILEHANDLE1. Im Parameter FN FILETYPE2 muß die Art der Bild-Datei angegeben werden. Return-Wert: Im Erfolgsfall wird das er …
@RTAddPopUpEnd
Fügt eine logische PopUp-Klammer-Zu zu dem Richtext Feld RT3 hinzu. Siehe @RtAddPopUpStart.
@RTAddPopUpStart
Fügt den TEXT TEXT1 oder die CNFORMULA CNFORMULA1 als PopUp mit den PopUp-Flags FN FLAGS2 an das Ende des Rich-Text RT RT3 an. Dies ist als eine logische Klammer auf zu betrachten. Alles was danach an das Rich-Text-Feld …
@RTAddText
Fügt den TEXT TEXT1 in der Schrift NUMBERLIST STYLE2 an das Ende des Rich-Text RT RT3 an. FN STYLE2: 1. StyleDefinitionNumber 2. Schriftart 3. Größe 4. Optionen 5. Color 1. StyleDefinitionNumber: Reserviert 2. …
@RTAttachmentIconChange
Es wird die Variable RT RT1 nach File-Icon's durchsucht, die zu den in TEXT/TEXTLIST TEXT1/TEXTLIST1 angegebenen File-Attachments verweisen. Dabei gefundenene File-Icons werden in die, in TEXT/TEXTLIST TEXT2/TEXTLIST2 (k …
@RTDocFontsAddFont
Fügt zu einem Font Feld HRT HRT1 (der Name ist in der Regel $Fonts) einen neuen Font mit dem Namen TEXT TEXT2 und der Font Family FN FNFONTFAMILY3 (optional) hinzu. Return-Wert: Ein FontHandle (NUMBER) auf den neuen Font …
@RTDocFontsGet
Gibt die Verfügbaren Fonts des Font-Felds HRT HRT1 (der Name ist in der Regel $Fonts) zurück. In RETTEXTLIST2 wird eine TEXTLIST mit den Namen der enthaltenen Fonts zurückgegeben. In RETNUMBERLIST3 wird eine NUMBERLIST m …
@RTFetchInit
Initialisiert eine Paragraph-weise Abfrage der RICHTEXT Variable HRT HRT1. Return-Wert: Im Erfolgsfall wird ein Fetch-Handle auf das HRT Feld HRT1 zurückgegeben, andernfalls @ERROR. Dieser Fetch-Handle muß an @RTFetchPar …
@RTFetchParagraph
Gibt bei jedem Aufruf jeweils einen Paragraph des RICHTEXT Feldes HRT HRT1 in RT REGRTPARAGRAPH zurück. (Dieser Paragraph wird als plain RT und nicht als HUGERICHTEXT zurückgegeben) Der Fetch-Handle RTFH muß zu Begin dur …
@RTFetchText
Gibt den Textanteil von HRT HRT1 als TEXT Portionsweise zurück. Zu Beginn muß NUMBER RETNUMBER2 0 enthalten. NUMBER RETNUMBER2 gibt den SEGMENTPOINTER an. @RTFetchText gibt für den Fall das noch mehr Text abzuholen ist i …
@RTInit
Diese Funktion initialisiert einen leeren Rich-Text. Mit FLOATLIST MARGINLIST1 können Ränder und mit FLOATLIST TABLIST2 Tabulatoren für diese Feld gesetzt werden. MARGINLIST1: 1. Linker Rand in cm 2. Rechter Rand in cm …
@RTInitEmpty
Diese Funktion initialisiert einen absolut leeren Rich-Text (0 Bytes). Achtung: Die Field-Flags (siehe @SetFieldFlags) der Return-Variable werden auf 0 so gesetzt! Dies ist nötig, da Richtext Felder kein SUMMARY Flag ges …
@RTSigTranslate
Gibt zu einem RICHTEXT-Paragraphen-Signal (eine Art Identifier für eine Portion RICHTEXT) einen aussagekräftigeren TEXT zurück. Im Parameter FN FNMODE muß die Art des RICHTEXT-Feldes angegeben werde. (Als default wird no …
@SaveMain
Nur innerhalb IDF: Negiert die generelle Aussage zum Abspeichern des MAIN Dokumentes. Siehe IDF-Dokument SECTION SYSTEM.
@ScanDB
Sucht alle Dokumente in der Datenbank mit dem DBHANDLE DBHANDLE1 die der Selection-Formula TEXT FORMULA2 entsprechen, vor dem Zeitpunkt TD SINCE3 in dieser DB geändert wurden und in NOTECLASSES NOTECLASSES4 enthalten sin …
@ScanDBDeleted
Sucht alle gelöschten Dokumente in der Datenbank mit dem DBHANDLE DBHANDLE1 und der/den NOTECLASS(EN) NOTECLASSES2. Der optionale Parameter TD SINCE4 grenzt die Suche auf die Dokumente ein, die seit dem angegebenen Datum …
@ScanOSDirectory
Sucht ein Verzeichniss nach darin enthaltenen Files ab. In TEXT OSMATCHPATH wird der OSPath mit den Suchkriterien angegeben (WILDCARDS...). In TEXT OPTIONS1 können die Dateiattribute angegeben werden, die die zu suchende …
@ScanVStack
Gibt alle Variablen auf dem VStack mit dem Namen TEXT NAME1 als TEXTLIST zurück. Variablen der Daten-Typen PV und UA werden dabei nicht berücksichtigt. Wenn für NAME1 nur "" angegeben wird, dann werden die Variablen von …
@SearchKeyList
Diese @Funktion durchsucht die sortierte HUGETEXTLIST HTL1 nach dem TEXT TEXT2 (dieser muß vollständig als ein Element der HUGETEXTLIST HTL1 enthalten sein) und gibt, falls vorhanden, die Position des TEXT TEXT2 in der H …
@Second
Gibt die Sekunden von TD/TDLIST TD1/TDLIST1 zurück. Wird die @Function mit dem Parameter TEXTOPTIONS aufgerufen, bestimmt dieser den Rückgabetyp. F=Wie ohne TEXTOPTIONS (Rückgabe-Datentyp = FLOAT/FLOATLIST) A=Rückgabe-Da …
@ServerPing
Mit dieser @Funktion kann die Erreichbarkeit bzw. die Verfügbarkeit des Servers mit dem Namen TEXT TEXT1 geprüft werden. Return-Wert: Falls der Server antwortet wird der Workload Index (FN) des Servers zurückgegeben, and …