Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@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 …
@SetACL
Schreibt eine ACL wie sie durch die angegebenen Parameter definiert wird in die Datenbank mit dem DBHANDLE DBHANDLE. Es muss in dieser ACL immer mindestens ein Eintrag mit ACL-LEVEL=6 enthalten sein. Der APIEngine-Server …
@SetACLMaxINetAccess
Setzt den Maximum Internet Access der DB mit dem DBHANDLE DBHANDLE1 auf den Level FN FNLEVEL2. FNLEVEL2: 6=(Manager) Manager 5=(Developer) Entwickler 4=(Editor) Editor 3=(Author) Autor 2=(Reader) Leser 1=(Depos …
@SetAttachmentFlags
Setzt die Flags FN FNFLAGS3 für das Attachment an der Position FN FNATTACHMENTNR2 in dem Dokument mit dem NOTEHANDLE NOTEHANDLE1. Die Positionen sind gleich zu denen, wie sie von @AttachmentInfo zurückgegeben werden. Im …
@SetAttachmentHostType
Setzt den HostType FN FNHOSTTYPE3 für das Attachment an der Position FN FNATTACHMENTNR2 in dem Dokument mit dem NOTEHANDLE NOTEHANDLE1. Die Positionen sind gleich zu denen, wie sie von @AttachmentInfo zurückgegeben werde …
@SetDBARConnection
Setzt, in der DB mit dem DBHANDLE DBHANDLE1, die Einstellungen der Advanced Replication Connection vom Quellserver TEXT SOURCESERVER zum Zielserver TEXT DESTINATIONSERVER, wenn es eine Definition für dieses Zielserver/Qu …
@SetDBLaunchOptions
Setzt die DB-Launch-Optionen der DB mit dem DBHANDLE DBHANDLE1. In FN FNOPTIONS werden die DB-Launch-Optionen der DB angegen. In TEXTLIST TEXTLIST1 werden die Namen der Navigatoren bzw. der View angegeben. In RID RID1 wi …
@SetDBObjectStoreID
Diese @Funktion assoziiert die Datenbank mit dem DBHANDLE DBHANDLE1 mit der Notes-Object-Store-Datenbank mit der RID RID2. Return-Wert: Im Erfolgsfall TRUE, andernfalls @ERROR.
@SetDBOptions
Setzt die DB-Optionen die in FN FN2 angegeben sind in die DB mit dem DBHANDLE DBHANDLE1. Wird FN FNEXTOPTIONS angegeben werden auch die erweiterten Optionen der DB gesetzt, sonst bleiben diese unverändert. Im Erfolgsfall …
@SetDBQuota
Setzt die DB-Quota der DB mit dem DBHANDLE DBHANDLE1 auf die in FNLIST FNLISTQUOTA2 angegebenen Werte. Element Nr. Bedeutung 1 Maxium size in kB of the database 2 Actual size in kB of the database 3 Quota in kB o …
@SetDBReplicaInfo
Setzt in der Datenbank mit dem DBHANDLE DBHANDLE1 die Replikations-Informationen Replik-ID TD REPLICAID2, Replikations-Flags FN FLAGS3, Replikations-Lösch-Interval FN CUTOFFINTERVAL4 und Replikations-Lösch-Zeitpunkt TD C …
@SetDBTitle
Setzt den Titel und die Kategorien der Datenbank mit dem DBHANDLE DBHANDLE1. Bei TEXT TEXT2 wird dieser als Titel interpretiert und die Kategorien werden gelöscht, bei TEXTLIST TEXTLIST2 wird das erste Element der Liste …
@SetDocPrivileges
Setzt im Dokument mit dem NOTEHANDLE NOTEHANDLE1 die Privilegien die in der FLOATLIST PRIVILEGES2 angegeben sind.
@SetEnvironment
Setzt die Umgebungsvariable TEXT TEXT1 auf den Wert TEXT TEXT2.
@SetFieldFlags
Setzt die Field Flags FN2 für Notes in eine Variable. Werden einer Variable nicht explizit mit @SetFieldFlags Flags zugewiesen, werden die default Werte angenommen. Wurden jedoch Flags zugewiesen gelten immer diese. Fiel …
@SetLinkListProperties
Setzt die Eigenschaften des Dokumenten-Links an der Position FN POSITION2 in der VSPECLINKLIST DOCLINKLIST1. TD TDRID3 ist die Replik-ID der DB auf die der Dokumenten-Link verweisen soll. (Wird hier @AnyAllDay angegeben, …
@SetListElement
Ersetzt das Element an FN POSITION2 von FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/IDLIST/HUGETEXTLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/IDLIST1/HUGETEXTLIST1 durch FN3/TEXT3/TD3 und gibt die neue Liste als Ergebnis zurück. …
@SetLocalServerTime
Setzt die Domino-Server Zeit. ACHTUNG: Das Verändern der Notes-Server-Zeit kann zu Nebeneffekten führen. Im Besonderen, wenn die Zeit in die Vergangenheit zurückgedreht wird. (Zum Beispiel können Dokumente verschwinden b …
@SetLogDocField
Setzt ein Feld mit dem Namen TEXT TEXT1 und dem Inhalt TEXT/TEXTLIST/FN/FNLIST/TD/TDLIST TEXT2/TEXTLIST2/FN2/FNLIST2/TD2/TDLIST2 in das aktuelle APILog-Document.
@SetNoteClass
Setzt die NOTECLASS FN2 (siehe NOTECLASSES) in das Dokument mit dem NOTEHANDLE NOTEHANDLE1. Zurückgegeben wird TRUE oder ein ERROR. NOTECLASS: DEC BIT Bedeutung 00000 XX No Notes keine Dokumente 00001 01 Do …
@SetNoteDB
Assoziiert das Dokument mit dem NOTEHANDLE NOTEHANDLE1 mit der DB die durch DBHANDLE DBHANDLE1 repräsentiert wird. Return-Wert: Im Erfolgsfall wird TRUE zurückgegeben, andernfalls @ERROR.
@SetNoteID
Setzt die NOTEID auf FLOAT FLOAT2 für das Dokument, das durch NOTEHANDLE NOTEHANDLE1 repräsentiert wird.
@SetNoteOID
Setzt die OID auf FLOAT OID2 für das Dokument, das durch NOTEHANDLE NOTEHANDLE1 repräsentiert wird. Diese @Funktion kann nur auf in dieser DB neu erstellte Dokumente angewendet werden.
@SetNTComPortEventMask
Aktuelle Event-Mask für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 neu setzen. Mit einem anschließenden @WaitNTComPortEventMask kann dann anschließend auf das Auftreten eines Events gewartet werden. FN MASK2: Bit HEX C-Sy …
@SetNTComPortHandshake
Aktuelle Handshake-Einstellung für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 ändern. Einzelne Werte können durch Übergabe von -1 vor dem Verändern bewahrt werden. FN RTS2: (Ready-to-send) Wert C-Symbol Bedeutung 0 …
@SetNTComPortSettings
Aktuelle Einstellungen für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 ändern. Durch Übergabe von -1 bzw. eines ungültigen Wertes können einzelne Werte beibehalten werden. Für die Ermittlung der erlaubten Werte kann @GetNTComP …
@SetNTComPortTimeouts
Aktuelle Timeout-Einstellungen für COM-Port mit OSCOMHANDLE OSCOMHANDLE1 neu setzen. Mit Außnahme von FN RDINT2 werden mit allen angegebenen Werten Timeouts spezifiziert, die vom Beginn der Operation anfangen zu zählen, …
@SetOSComPortInfo
FNWRTO1: Write TimeOut (angaben ?? regulär 6000) Unter NT ist das WriteTotalTimeoutConstant. Siehe http://msdn2.microsoft.com/en-us/library/ms885171.aspx. FNRETO1: Read TimeOut (angaben ?? regulär 6000) Unter NT ist das …