Engine Help Kategorie: Text
Gefilterte Übersicht der Engine-Help-Dokumentation.
@APIServerName
Gibt den Namen (TEXT) des Servers zurück auf dem dieses Programm ausgeführt wird.
@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.
@BoolNeg
Negiert FN/TEXT FN1/TEXT1, wobei das Ergebnis immer vom Typ NUMBER ist. Bei Verwendung von TEXT1 ist ein Leertext gleichzusetzen mit einem FALSE und ein beliebiger nichtleerer Text mit TRUE.
@BroadcastNewMail
Versendet die Nachricht über den Empfang eines neuen Mails an die Workstation des Users mit dem Namen TEXT TEXT1. ACHTUNG: Dazu muß auf der Workstation des Users der Server der diese Nachricht versendet als Mail-Server e …
@BuildList
Erstellt eine Liste mit FN COUNT2 gleichen Elementen FN/TEXT/TD/ID FN1/TEXT1/TD1/ID1.
@CallDEFFNFunction
Ruft die GLOABLe DEFFN Funktion mit dem Namen TEXT TEXTGLOBALGFUNNAME und den folgenden Parametern auf. Die Return-Parameter werden durch die Definition der DEFFN Funktion bestimmt -> siehe FUNKTIONEN. Die GLOBALe DEFFN …
@CallIDF
Ruft ein IDF-Dokument mit dem TEXT IDFNAME1 als Sub-Processing auf. Es wird die Datei mit dem OSPATH OSPATH2 eingezogen. ACHTUNG: Lokale Variablen aus dem Haupt-Processing sind im vom @CallIDF aufgerufenem Programm nicht …
@CallPRC
Ruft ein PRC-Dokument mit dem TEXT PRCNAME1 als Sub-Processing auf. ACHTUNG: Lokale Variablen aus dem Haupt-Processing sind im vom @CallPRC aufgerufenem Programm nicht zugänglich und umgekehrt. Daten (Variablen) können n …
@Char
Wandelt den in FN/FNLIST FN1/FNLIST1 angegebenen ASCII-Code in das entsprechende Zeichen, bzw. eine Liste von Zeichen um.
@CheckDefine
Prüft ob ein "Begriff" (der zur bedingten Compilierung genutzt werden kann) definiert ist oder nicht. Ist der "Begriff" definiert gibt @CheckDefine NUMBER 1 (TRUE) zurück. Ist der "Begriff" nicht definiert gibt @CheckDef …
@CloseMutexSemaphore
Schließt die Mutex-Semaphore mit dem Mutex-Semaphore-Handle (MSH) MUTEXSEMAPHOREHANDLE. Im Erfolgsfall wird ein geschlossener Mutex-Semaphore-Handle (MSH) zurückgegeben, andernfalls @ERROR. Eine Mutex-Semaphore kann nur …
@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 …
@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 …
@CreateMutexSemaphore
Erzeugt eine Mutex-Semaphore mit dem Namen TEXT TEXTSEMAPHORENAME. Im Erfolgsfall wird ein Mutex-Semaphore-Handle (MSH) zurückgegeben, andernfalls @ERROR. Eine Mutex-Semaphore kann nur von einem Task zu einem Zeitpunkt b …
@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 …
@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 …
@Define
Definiert einen "Begriff" der zur bedingten Compilierung genutzt werden kann. Im Unterschied zum Keyword DEFINE wird @Define zur Ausführungszeit (und nur wenn dieser @Define ausgeführt wird) wirksam. TEXT1 darf keine Spa …
@DeleteEnvironment
Löscht die Umgebungsvariable TEXT TEXT1 physikalisch aus der NOTES.INI. ReturnWert: 1 = Variable konnte gelöscht werden. 0 = Varaible nicht vorhanden. @Errro... = Es ist ein Fehler aufgetretten, die Variable wurde nicht …
@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.
@Environment
Liefert den Wert der Umgebungsvariable TEXT/TEXTLIST TEXT1/TEXTLIST1 zurück.
@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 …
@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 …
@GetEngineTasks
Gibt eine Liste (TEXTLIST) der beim Aufruf der @Funktion aktiven Engine-Tasks zurück.
@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.
@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 …
@GetSessionID
Gibt eine neue SessionID zurück.
@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 …
@HashPassword
Generiert aus dem TEXT TEXTPASSWORD1 einen Hash, der als TEXT zurückgegeben wird. Im Fehlerfall liefert @HashPassword @Error zurückgegeben. Diese @Function erzeugt einen Hash, der kompatibel ist zu einem mit Typ 2 (FN FN …
@HookUpdateFields
Mit dieser @Funktion werden, durch das Engine-Script der gloablen HOOK-Funktion, geänderte Felder, des Dokuments mit dem NOTEHANDLE NOTEHANDLE1, zurück in das Dokument transferiert.
@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 …
@IndexOf
Ermittelt ob im TEXT/BUFFERHANDLE TEXTINSTRING/BUFFERHANDLE der TEXT/ die Elemente der TEXTLIST TEXTSEARCH enthalten ist/sind und wenn ja, an welcher/welchen Position(en) sich dieser befindet/befinden. Die Position begin …
@IPHexDump2DecAdr
Wandelt IP-Adresse(n) in der HEXDump Notation (TEXT/TEXTLIST TEXT1/TEXTLIST1) in IP-Adresse(n) in der dezimalen Punkt-Notation um, und gibt diese zurück. HEXDump Notation: Eine IP-Adresse darf 7 oder 8 Stellen lang sein. …
@IsMember
Gibt zurück, ob TEXT/TEXTLIST TEXT1/TEXTLIST1 vollständig in TEXT/TEXTLIST TEXT2/TEXTLIST2 enthalten ist. Wenn TEXTLIST1 keine Elemente enthält hängt das Ergebnis von dem Vorhandensein von Elementen in TEXTLIST2 ab: Ist …
@IsNotMember
Gibt 1 zurück, wenn TEXT/TEXTLIST TEXT1/TEXTLIST1 nicht vollständig in TEXT/TEXTLIST TEXT2/TEXTLIST2 enthalten ist, ansonsten 0. Wenn TEXTLIST1 keine Elemente enthält, hängt das Ergebnis von dem Vorhandensein von Element …