DE 844 Dokumente

Engine Help: Function

Gefilterte Übersicht der Engine-Help-Dokumentation.

← Zurück zur Engine-Help-Übersicht

581 Dokumente gefunden

@SetEnvironment

Function Version 2.10

Setzt die Umgebungsvariable TEXT TEXT1 auf den Wert TEXT TEXT2.

@SetFieldFlags

Function Version 2.10

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

Function Version 5.00

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

Function Version 1.90

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

Function Version 5.00

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

Function Version 4.50

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

Function Version 2.10

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

Function Version 2.10

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

Function Version 2.10

Setzt die NOTEID auf FLOAT FLOAT2 für das Dokument, das durch NOTEHANDLE NOTEHANDLE1 repräsentiert wird.

@SetNoteOID

Function Version 1.90

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

Function Version 4.00

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

Function Version 4.00

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

Function Version 4.00

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

Function Version 4.00

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

Function Version 3.00

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

Function Version 3.00

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 …

@SetPosAttachedFile

Function Version 4.60

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

Function Version 5.00

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

Function Version 1.91

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

Function Version 4.60

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

Function Version 4.50

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

Function Version 4.50

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

Function Version 1.90

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

Function Version 3.00

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

Function Version 2.00

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

Function Version 2.97

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

Function Version 1.90

Führt die OS2-Shell-Kommandos in TEXT COMMAND1 aus und gibt den Return-Status zurück.

@ShiftList

Function Version 1.90

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

Function Version 1.90

Berechnet den Sinus von FN/FNLIST FN1/FNLIST1.

@Sleep

Function Version 4.00

Hält die Bearbeitung des aktuellen Scripts um FN COUNT1 1/10 Sekunden an. Da hierbei ein Idle-Wait durchgeführt wird, der den Prozessor nicht belegt, ist diese Funktion einer leeren Zählschleife in jedem Fall vorzuziehen …

@SleepMS

Function Version 10.04

Hält die Bearbeitung des aktuellen Scripts um FN COUNT1 Millisekunden an. Da hierbei ein Idle-Wait durchgeführt wird, der den Prozessor nicht belegt, ist diese Funktion einer leeren Zählschleife in jedem Fall vorzuziehen …

@SortList

Function Version 2.00

Sortiert den/die TEXT/TEXTLIST TEXT1/TEXTLIST1 und gibt diese sortierte Liste zurück. Optional kann eine Reorganisationsliste NUMBERLIST SEQUENCE1 zurückgegeben werden. Diese kann mit @ReorgList dazu benutzt werden, um a …

@Soundex

Function Version 1.90

Gibt einen numerischen Code für TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück, der einen homophonen (gleichklingenden) Vergleich ermöglicht. Sie wird hauptsächlich im Adressbuch gebraucht.

@Sqrt

Function Version 1.90

Berechnet die Quadratwurzel von FN/FNLIST FN1/FNLIST1.

@StartOSComPortTransmit

Function Version 3.00

Started die Pufferung und Übertragung (mit Handshake etc) für den COMPORT mit dem OSCOMHANDLE OSCOMHANDLE1.

@StopOSComPortTransmit

Function Version 3.00

Stoppt die Pufferung und Übertragung (mit Handshake etc) für den COMPORT mit dem OSCOMHANDLE OSCOMHANDLE1.

@StringExceptions

Function Version 2.00

Die StringExceptions (Siehe Texte StringExceptions) die der Compiler bei statischen Texten ausführt werden durch @StringExceptions auch auf den übergebenen TEXT TEXT1 ausgeführt. Beispiel @StringExceptions(TEXT1): Text:= …

@Subset

Function Version 1.90

Gibt eine Teilliste von FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/IDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/IDLIST1 zurück. Ist FN COUNT2 positiv, so werden die ersten COUNT2 Elemente zurückgegeben, ist COUNT2 negativ, dann …

@SumOfList

Function Version 1.90

Gibt die Summe der FN/FNLIST FNLIST1/FN2 zurück. Mit FN FROM2 und FN TO3 kann ein Bereich für die Summation festgelegt werden, es wird dann von Element FROM2 bis Element TO3 aufsummiert.

@SwitchLogDoc

Function Version 4.50

Nach dem Aufruf dieser @Function wird das Log in einem neuen Folge-APILOG-Dokument fortgesetzt. Beispiel @SwitchLogDoc: @LogReport("document 1"); @SwitchLogDoc; @LogReport("document 2"); Die Zeile "document 1" wird im er …

@Tan

Function Version 1.90

Berechnet den Tangens von FN/FNLIST FN1/FNLIST1.

@TaskShouldStop

Function Version 4.50

Liefert als Return-Wert eine 1, wenn die Engine beenden soll, weil z.B. der Domino-Server heruntergefahren wird. Diese Funktion kann als Abbruchbedingung für sehr lange Schleifen bzw. Endlosschleifen benutzt werden, die …

@Text

Function Version 1.90

Wandelt FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/UIDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/UIDLIST1 in einen TEXT/TEXTLIST um und gibt ihn zurück. (Bei UIDLIST ist der Rückgabe-Datentyp immer TEXTLIST) HINWEIS: @Text in d …

@TextToDigits

Function Version 2.00

Wandelt die ASCII Zeichen von TEXT/TEXTLIST TEXT1/TEXTLIST1 in die dazugehörigen ASCII-CHAR Werte um und gibt sie in Form eines/einer TEXT/TEXTLIST wieder zurück. In OPTIONS1 wird angegeben in welchem Zahlensystem die AS …

@TextToNumber

Function Version 1.90

Wandelt den/die TEXT/TEXTLIST TEXT1/TEXTLIST1 in eine(n) FLOAT/FLOATLIST und gibt diese(n) zurück. Mit FN MODE2 kann der Modus der Umwandlung bestimmt werden, fehlt er wird er mit Null angenommen. HINWEIS: @TextToNumber …

@TextToTime

Function Version 1.90

Wandelt den Text TEXT/TEXTLIST TEXT1/TEXTLIST1 in einen Zeit-Datums-Wert TD/TDLIST um. TEXT TEXTOPTIONS: Wird hier "*" angegeben, werden die Texte im TD-Hex-Dump-Format (z.B. "C1255DF0:004B73DC" (entspricht "14.09.1992 1 …

@TextToTimePair

Function Version 4.60

Wandelt den Text TEXT TEXT1 in einen Zeit-Datums-Paar-Wert TDLIST um. Als Trennzeichen für das Zeit-Datums-Paar ist ein "-" zu verwenden. Als Trennzeichen zwischen einzelnen Datumskomponenten ist kein "/" bzw. "-" zu ver …

@TextToUID

Function Version 2.10

Wandelt den Text TEXT/TEXTLIST TEXT1/TEXTLIST1 in eine UIDList um. TEXT1 bzw. die einzelnen Elemente von TEXTLIST1 müssen eine Länge von 32 Zeichen haben.

@Time

Function Version 1.90

Setzt aus den Einzelwerten FN YEAR1/MONTH2/DAY3/HOUR4/MINUTE5/SECOND6 einen Zeit-Datums-Wert TD zusammen und gibt diesen zurück. HINWEIS: @Time in der Engine unterscheidet sich geringfügig von der Notes-@Funktion @Time! …