Engine Help Kategorie: List
Gefilterte Übersicht der Engine-Help-Dokumentation.
@Abs
Berechnet den Absolutwert von FN/FNLIST FN1/FNLIST1.
@Adjust
Ändert die einzelnen Stellen des Zeit-Datums-Wert TD/TDLIST TD1/TDLIST1 um die Werte die in FN YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 angegebenen sind. YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 wird dabei auf Jahr/Monat/T …
@Author
Im Prinzip analog zu Notes. Wenn ein Feld mit dem Notes V2.0/V2.1 Datentyp Author übergeben wird, so wird der Text-Anteil dieses Datentyps als Text zurückgegeben.
@BitAnd
Führt ein bitweises, logisches UND auf FN/FNLIST FN1/FNLIST1 und FN/FNLIST FN2/FNLIST2 aus. (Es wird intern ein 32Bit Wert zugrunde gelegt.)
@BitOr
Führt ein bitweises, logisches ODER auf FN/FNLIST FN1/FNLIST1 und FN/FNLIST FN2/FNLIST2 aus.
@BitVektor
Gibt einen BitVektor (NUMBER) zurück, bei dem die in FN/FNLIST FN1/FNLIST1 angegebenen Bits gesetzt sind.
@BitXor
Führt ein bitweises, logisches EXKLUSIV-ODER auf FN/FNLIST FN1/FNLIST1 und FN/FNLIST FN2/FNLIST2 aus.
@BuildList
Erstellt eine Liste mit FN COUNT2 gleichen Elementen FN/TEXT/TD/ID FN1/TEXT1/TD1/ID1.
@BuildNamedDocKeyLists
Diese @Function erzeugt zwei korrespondierende Listen (HUGETEXT RETHTL und IDLIST RETIDL). In der Liste HUGETEXT RETHTL werden alphabetisch sortiert die Inhalte der Felder, aus den durch die Selektionsformeln TEXT FORMUL …
@Char
Wandelt den in FN/FNLIST FN1/FNLIST1 angegebenen ASCII-Code in das entsprechende Zeichen, bzw. eine Liste von Zeichen um.
@CloseQueue
Schließt die Message-Queue mit dem Queue-Handle VSPECQUEUEHANDLE QUEUEHANDLE. Im Erfolgsfall wird TRUE zurückgegeben, andernfalls @ERROR.
@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 …
@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 …
@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 …
@Date
Gibt den Datumsanteil von TD/TDLIST TD1/TDLIST1 zurück.
@Day
Gibt den Tag im Monat 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ückgab …
@DebugFollowFun
Definiert @Funktionen die bei Aufruf die INPUT und OUTPUT Parameter dokumentieren sollen. Es muß mit dem KEYWORD DEBUG der Modus "FOLLOW" aktiviert sein um die Liste die mit @DebugFollowFun definiert wird auch zu berücks …
@DebugFollowVar
Definiert Variablen die bei Verwendung dokumentieren sollen. Es muß mit dem KEYWORD DEBUG der Modus "FOLLOW" aktiviert sein um die Liste die mit @DebugFollowVar definiert wird auch zu berücksichtigen. @DebugFollowVar wir …
@DeleteListElement
Es wird aus der FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST FNLIST1/TDLIST1/TEXTLIST1/IDLIST1/HUGETEXTLIST1 das Element an der Position FN FN2 gelöscht.
@DigitsToText
Wandelt die ASCII-CHAR Werte in TEXT/TEXTLIST TEXT1/TEXTLIST1 in die dazugehörigen ASCII-Texte um und gibt sie als TEXT/TEXTLIST wieder zurück. Im zweiten Parameter wird angegeben in welchem Zahlensystem die ASCII-CHAR W …
@Elements
Gibt die Anzahl der Elemente von FNLIST/TEXTLIST/TDLIST/IDLIST FNLIST1/TEXTLIST1/TDLIST1/IDLIST zurück. Wird der @Funktion keine Liste als Argument übergeben, ist das @Funktions-Ergebnis 1.
@ExpandGroups
In TEXT/TEXTLIST TEXT1/TEXTLIST1 werden alle angegebenen Gruppennamen durch ihre Mitglieder ersetzt. Dabei bleiben unbekannte Gruppennamen erhalten und die so entstandene Liste wird als @Funktionsergebnis zurückgegeben. …
@Explode
Zerlegt den TEXT/TEXTLIST TEXT1/TEXTLIST1 in eine TEXTLIST. Dabei wird bei jedem Auftreten eines Leerzeichens der TEXT1 bzw. jedes Element von TEXTLIST1 abgetrennt und zu einem eigenen Element gemacht. Mit TEXT SEPTEXT2 …
@FloatToNumber
Wandelt FN FN1 bzw. FNLIST FNLIST1 in eine NUMBER bzw. NUMBERLIST um, dabei werden vorhandene Nachkommastellen abgeschnitten. HINWEIS: Alle Zahl-Konstanten sind in der APIEngine vom Typ FLOAT/FLOATLIST. ACHTUNG: Der Bere …
@FolderAddDoc
Diese @Function fügt, in der DB mit dem DBHANDLE DBHANDLE1, die Dokumente ,deren NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 angegeben werden, in den Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2 ein. ReturnWert: Wurd …
@FolderRemoveDoc
Diese @Function entfernt, in der DB mit dem DBHANDLE DBHANDLE1, die Dokumente ,deren NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 angegeben werden, aus dem Folder mit dem VIEWHANDLE VIEWHANDLEFOLDER2. (Das Dokument w …
@GetDataType
Gibt in ein bis vier Zeichen den Datentyp der Variable VAR1 zurück. Datentyp: Rückgabewert: TEXT A TEXTLIST AL NUMBER N NUMBERLIST NL FLOAT F FLOATLIST FL TD T TDLIST TL RT (RICHTEXT) RT ID …
@GetFieldFlags
Gibt die Field-Flags für Notes von einer Variable zurück. Field-Flags: 1 SIGN 2 SEAL 4 SUMMARY 16 SEALED 32 READ/WRITE-ACCESS 64 NAMES 256 PLACEHOLDER 512 PROTECTED 1024 READ-ACCESS Praktische Beispiele …
@GetLastNotesErrorCode
Gibt den Notes-Error Code der letzten Notes-Funktion dieses Tasks als FN zurück. (Kann also auch NOERROR=0 sein.) Siehe auch @GetNotesErrorString.
@GetLinkListProperties
Gibt die Eigenschaften des Dokumenten-Links an der Position FN POSITION2 aus der VSPECLINKLIST DOCLINKLIST1 zurück. TD RETTDRID3 ist die Replik-ID der DB auf die der Dokumenten-Link verweist. (Steht hier @AnyAllDay verwe …
@GetListElement
Gibt das Element an FN/FNLIST POSITION2/POSITIONLIST2 von FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/ID/IDLIST/HUGETEXTLIST/UNIDLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/ID1/IDLIST1/HUGETEXTLIST1/UNIDLIST1 zurück, wobei im Fal …
@GetProfileField
Gibt 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 a …
@GetQueue
Holt die nächste Message der Message-Queue mit dem Queue-Handle VSPECQUEUEHANDLE QUEUEHANDLE. Im Erfolgsfall wird die Message (TEXT) zurückgegeben, andernfalls @ERROR (nur ein Parameter Version, andernfalls "" (NULLSTRIN …
@GetServerStats
Holt die Statistics Einträge des Servers TEXT TEXT1 und gibt diese als TEXTLIST zurück. Mit dem optionalem Parameter TEXT TEXT2 kann die Facility eingegrenzt werden, so daß nur noch Einträge aus diesem Bereich zurückgege …
@GetThreadID
Gibt die ThreadID (FN) des Thread's zurück dessen Skript diese @Function ausführt.. Der optionale Parameter FN FNTYPEOFTASKID bestimmt ob die ThreadID des Betriebssystems oder die Engine-Interne TaskID (wird z.B. bei "sh …
@GetThreadIDText
Gibt die ThreadID des Thread's als TEXT zurück dessen Skript diese @Function ausführt.
@GetVar
Gibt den Wert der Variablen mit dem Namen TEXT NAME1 zurück. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 angegeben werden. Hiermi …
@GetVarWithFieldFlags
Gibt den Wert der Variablen mit dem Namen TEXT NAME1 zurück. Falls die Variable zu einer Gruppe (z.B. einem Dokument) gehört muß der Gruppenname (z.B. der NOTEHANDLE vom Dokument) als TEXT GROUP2 angegeben werden. Hiermi …
@GetVStackPath2GFun
Liefert den Prefix für den Zugriffspfad einer Variable, die innerhalb der Thread-Kopie einer globalen Funktion gespeichert ist. Hiermit könnten z.B. Default-Werte für lokalen Parameter belegt werden. Nach Möglichkeit sol …
@Hour
Gibt die Stunden von TD/TDLIST TD1/TDLIST1 zurück. Wird die @Function mit dem Parameter TEXTOPTIONS aufgerufen, bestimmt dieser den Rückgabetyp. TEXT TEXTOPTIONS F=default (Rückgabe-Datentyp = FLOAT/FLOATLIST) A=Rückgabe …
@HugeTextList
Gibt eine Variable vom Typ HUGETEXTLIST mit 0 Elementen zurück.
@IDList
Gibt eine Variable vom Typ IDLIST mit 0 Elementen zurück.
@Implode
Fügt TEXT/TEXTLIST TEXT1/TEXTLIST1 zu einem einzigen TEXT zusammen. Dabei wird zwischen allen zusammengefügten Elementen ein Leerzeichen eingefügt. Mit TEXT SEPTEXT2 kann alternativ ein anderer Zwischentext gewählt werde …
@InsertListElement
Fügt das Element FN/TD/TEXT ELEMENT3 in die Liste FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST LIST1 ein. Die Einfügeposition wird durch FN FN2 angegeben.
@Integer
Schneidet die Nachkommastellen von FN/FNLIST FN1/FNLIST1 ab und gibt die ganzzahligen Werte zurück.