Engine Help: S
Gefilterte Übersicht der Engine-Help-Dokumentation.
@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 die ACL die durch PARAMETER2-5 beschrieben wird in die Datenbank mit dem DBHANDLE DBHANDLE. Es muß in dieser ACL immer mindestens ein Eintrag mit ACL-LEVEL=6 enthalten sein. Der APIEngine-Server der die ACL schr …
@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
Nur für Engine unter Windows! 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 werd …
@SetNTComPortHandshake
Nur für Engine unter Windows! 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 …
@SetNTComPortSettings
Nur für Engine unter Windows! 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 e …
@SetNTComPortTimeouts
Nur für Engine unter Windows! 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 …
@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 …
@SetOSComPortLineInfo
Setzt die PortInfo zu einem OSCOMPORT (Device). 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 ??? Beisp …
@SetOSComPortSpeed
Setzt die an dem OSCOMPORT verwendete Baud-Rate.
@SetPosAttachedFile
Setzt die Position in dem File-Attachment mit dem OBJECTFILEHANDLE OBJECTFILEHANDLE1 auf die in FN POSITION2 angegebene Position (in Byte) unter Berücksichtigung des Modus TEXT MODE3. Die neue Position wird zurückgegeben …
@SetPosBuffer
Setzt die Position in dem BINBUFFER mit dem BUFFERHANDLE BUFFERHANDLE1 auf die in FN POSITION2 angegebene Position (in Byte) unter Berücksichtigung des Modus TEXT MODE3. MODE3: S=Vom Start des BINBUFFER an gerechnet C=Au …
@SetPosOSFile
Setzt die Position in dem OSFILE mit dem FILEHANDLE FILEHANDLE1 auf die in FN POSITION2 angegebene Position (in Byte) unter Berücksichtigung des Modus TEXT MODE3. MODE3: S=Vom Start des OSFILE an gerechnet C=Augenblickli …
@SetProfileField
Setzt 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 …
@SetSchedListEntry
Setzt die Daten für einen bestimmten Eintrag FN POSITION2 der SCHEDLIST SCHEDLIST1. In UID UID3 wird die UID des documents übergeben auf das sich dieser Eintrag bezieht. In TDLIST TDLRANGE4 wird die Zeitspanne dieses Ein …
@SetTaskTimeout
Aktiviert die Task Timeout Überwachung, für den Task, der @SetTaskTimeout aufruft. FN FN1 gibt die Zeit in Sekunden an, die der Task ab dem Aufruf der @Function noch benötigen darf bis zum nächsten Aufruf von @SetTaskTim …
@SetVar
Setzt den Wert der Variable(n) mit dem(den) Namen TEXT/TEXTLIST NAME1 auf den Wert VAR3. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GRO …
@SetVarFieldFlags
Setzt die Notes-Feld-Flags für das in TEXT NAME1 angegebene Feld auf den Wert FN FN1. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 …
@SetVarInVar
Setzt in die Variable VARDEST1 an der Position FN POSITION2 von der Variablen VARSOURCE2 ab der Position FN POSITION4 FN LENGTH Byte ein und gibt das Ergebnis zurück. Mit TEXT MODE6 kann die Art des Einsetzens näherer be …
@SetVarWithFieldFlags
Setzt den Wert der Variable(n) mit dem(den) Namen TEXT/TEXTLIST NAME1 auf den Wert VAR3. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GRO …
@Shell
Führt die OS2-Shell-Kommandos in TEXT COMMAND1 aus und gibt den Return-Status zurück.
@ShiftList
Verschiebt die FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1 in der Richtung FN DIRECTION3, setzt an die freigewordene Position FN/TEXT/TD FN2/TEXT2/TD2 und entfernt das Element am anderen End …
@Sin
Berechnet den Sinus von FN/FNLIST FN1/FNLIST1.
