Engine Help: Function
Gefilterte Übersicht der Engine-Help-Dokumentation.
@MoveFolder
Diese @Function verschiebt den Folder, in der DB mit dem DBHANDLE DBHANDLE1 und dem VIEWHANDLE VIEWHANDLEFOLDER2, unter den Folder mit dem VIEWHANDLE VIEWHANDLEPARENTFOLDER3. Die Folder müssen vom selben Typ (shared/priv …
@MySQLClose
Schließt einen VSPECMYSQL MySQLHandle. Der VSPECMYSQL MySQLHandle wird von @MySQLInit geliefert. Return: Im Erfolgsfall ein geschlosserner VSPECMYSQL MySQLHandle andernfalls @Error.
@MySQLClosePreparedStatement
Schließt einen MySQLPreparedStatementHandle. Return: Im Erfolgsfall einen geschlossenen PreparedStatement-Handle sonst @Error;
@MySQLConnect
Stellt eine Verbindung zum MySQL-Server her. Sollte nach @MySQLoptions aufgerufen werden. Der VSPECMYSQL MySQLHandle wird von @MySQLInit geliefert. TEXT Host (für lokal "" (NULLSTR)) TEXT User (kann u.U. auch "" (NULLSTR …
@MySQLCreatePreparedStatement
Erzeugt eine PreparedStatement Anfrage. Eine solche Anfrage stellt eine Art Template dar, das anschließend mit Daten zu einer vollständigen Anfrage ergänzt und ausgeführt werden kann. Diese Funktion ist für die mehrfache …
@MySQLExecutePreparedStatement
Führt eine vorbereitete Anfrage zum MySQLPreparedStatementHandle aus. Nach dem Handle werden die Parameter korrespondierend zur Anfrage angegeben. Return: Im Erfolgsfall TRUE sonst @Error; ACHTUNG der MySQLPreparedStatem …
@MySQLFetchColumn
Holt Spalte eines gespeicherten Ergebnises einer @MySQLQuery Anfrage. In FN FNColumnNumber wird die Spaltennummer angegeben. Wird der optionale Parameter FN FNVPR angegeben, wird das Ergebnis zusätzlich in die Variable z …
@MySQLFetchColumnLocalTD
Holt Spalte eines gespeicherten Ergebnises einer @MySQLQuery Anfrage. In FN FNColumnNumber wird die Spaltennummer angegeben. Zeitwerte werden in die locale Zeitzone konvertiert. (Dies ist eine Workaround Funktion wegen d …
@MySQLFetchRow
Holt eine Zeile ab der aktuellen Position (siehe @MySQLSeekResult) eines gespeicherten Ergebnisses einer @MySQLQuery Anfrage. Der VSPECMYSQLRES MySQLResultHandle wird von @MySQLQuery geliefert. Nachdem die aktuelle Zeile …
@MySQLFreeResult
Löscht ein gespeichertes Ergebnis einer @MySQLQuery Anfrage. Der VSPECMYSQLRES MySQLResultHandle wird von @MySQLQuery geliefert. Return: Im Erfolgsfall wird ein geschlossener VSPECMYSQLRES MySQLResultHandle zurückgegeben …
@MySQLGetAffectedRows
Gibt die Anzahl der vom letzten @MySQLQuery-Aufruf betroffenen Zeilen zurück. Der Aufruf dieser Funktion sollte unmittelbar nach den Aufruf von @MySQLQuery erfolgen und mit der MySQLResultHandle-Variable (oder falls kein …
@MySQLGetAffectedRowsPreparedStatement
Wenn die Anfrage ein INSERT,UPDATE oder DELETE Statement enthält wird die Anzahl der von diesem Statement betroffenen Zeilen zurückgegeben. Return: Im Fehlerfall @Error sonst den abgefragten Wert
@MySQLGetFieldDef
Gibt die Detailinformationen zu einer Felddefinition (zu einer Column) eines gespeicherten Ergebnises einer @MySQLQuery Anfrage zurück. In FN FieldIndex wird die Feldnummer angegeben, beginnend mit 0! RetName TEXT Name d …
@MySQLGetInsertID
Gibt die generierte ID einer AUTOINCREMENT ID Spalte zurück, wenn der letzte Aufruf von @MySQLQuery eine solche AUTOINCREMENT ID erzeugt hat. Der Aufruf dieser Funktion sollte unmittelbar auf den Aufruf von @MySQLQuery e …
@MySQLGetLastInsertIDPreparedStatement
Wenn die Anfrage ein INSERT Statement enthält und dieses auf eine AUTOINCREMENT ID Spalte einwirkt, wird die generierte ID zurückgegeben. Return: Im Fehlerfall @Error sonst den abgefragten Wert
@MySQLGetNumFields
Gibt die Anzahl der Felder (Columns) eines gespeicherten Ergebnises einer @MySQLQuery oder @MySQLExecutePreparedStatement Anfrage zurück. Return: Im Erfolgsfall die Anzahl sonst @Error;
@MySQLGetNumRows
Gibt die Anzahl der Zeilen/Rows eines gespeicherten Ergebnises einer @MySQLQuery oder @MySQLExecutePreparedStatement Anfrage zurück. Return: Im Erfolgsfall FN Anzahl andernfalls @Error;
@MySQLInit
Initialisiert MySQL und gibt einen VSPECMYSQL MySQLHandle zurück, dieser wird von anderen MySQL-@Functions benötigt. Return: Gibt im Erfolgsfall einen VSPECMYSQL MySQLHandle zurück andernfalls @Error;
@MySQLOptions
Setzt die Optionen. Sollte nach @MySQLInit aufgerufen werden. Derzeit wird nur die Option MYSQL_READ_DEFAULT_GROUP gesetzt. Wenn nur ein Parameter angegeben wird dieser Wert auf auf "engine" gesetzt, andernfalls auf den …
@MySQLQuery
Führt einen MySQL-Query aus. Wenn die Anfrage ein Ergebnis liefert kann dieses im VSPECMYSQLRES MySQLResultHandle gespeichert werden. Wenn die Anfrage ein INSERT Statement enthält und dieses auf eine AUTOINCREMENT ID Spa …
@MySQLSeekResult
Setzt die aktuelle Position (resp. Zeile/Row) in einem gespeicherten Ergebnis einer @MySQLQuery Anfrage. ACHTUNG:Die Zählung beginnt mit 0! Return: Im Erfolgsfall TRUE sonst @Error;
@MySQLThreadEnd
Diese @Funktion muss vor beenden eines Threads aufgerufen werden! HINWEIS: Diese @Funktion gibt den MySQL-Kontext frei! Nach dem Aufruf von @MySQLThreadEnd dürfen keine weiteren MySQL-Funktionen mehr aufgerufen werden.
@MySQLThreadInit
Initialisiert einen Thread für MySQL. @MySQLInit oder @MySQLConnect initialisieren ebenfalls einen Thread.
@Name
Im Prinzip analog zu Notes. Unterschied: Das KEYWORD muß in Anführungsstriche gesetzt werden: Also statt [CN] muß "[CN]" angegeben werden etc. KEYWORD: [O] [C] [OU1] [OU2] [OU3] [OU4] [CN] [Canonicalize] [Abbreviate] [To …
@Neg
Negiert FN/FNLIST FN1/FNLIST1, und gibt sie als FLOAT/FLOATLIST zurück.
@Newline
Gibt einen Zeilenvorschub zurück, der in TEXT/TEXTLIST verwendet werden kann.
@NewOID
Liefert eine OID für ein neues Dokument einer Datenbank mit dem DBHANDLE DBHANDLE1 zurück.
@NotesIDFileCloseCertifierCtx
Die @Funktion schließt den Certifier NotesID Context-Handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 und gibt VSPECPOTVAR zurück. Return-Wert: Im Erfolgsfall wird VSPECPOTVAR zurückgegeben, andernfalls @ERROR.
@NotesIDFileEncodePassword
Die @Funktion codiert das Klartext-Passwort TEXT TEXTPASSWORD1 und gibt das kodierte Passwort als VSPECENCPASSWORD zurück. Im Fehlerfall wird @ERROR zurückgegeben.
@NotesIDFileGetInfo
Diese @Funktion liefert diverse Informationen über das Notes-ID File mit dem OSPATH OSPATH1 zurück. Wenn das ID-File Passwort geschützt ist, sollte @NotesIDFileGetInfo nicht benutzt werden. Da in diesem Fall, an der Serv …
@NotesIDFileNewCertifier
Erzeugen einer neuen Notes Certifier ID. Optional kann zudem dein Eintrag im Namen&Adressbuch vorgenommen werden und ein Mail-File für den neuen Benutzer angelegt werden. Die Steuerung erfolgt im wesentlichen über FN IDT …
@NotesIDFileNewServer
Erzeugen einer neuen Notes Server ID. Optional kann zudem ein Eintrag im Namen&Adressbuch vorgenommen werden. Die Steuerung erfolgt im wesentlichen über FN IDTYPE und FN FLAGS. Alle anderen Parameter sind weitgehend opti …
@NotesIDFileNewWorkstation
Erzeugen einer neuen Notes ID. Optional kann zudem dein Eintrag im Namen&Adressbuch vorgenommen werden und ein Mail-File für den neuen Benutzer angelegt werden. Die Steuerung erfolgt im wesentlichen über FN IDTYPE, FN MA …
@NotesIDFileOpenCertifierCtx
Diese @Funktion öffnet den Cdertifier Context (Certifier Notes-ID) mit dem OSPATH OSPATH1. Im Parameter VSPECENCPASSWORD VSPECENCPASSWORD2 muß das kodierte Passwort (siehe @NotesIDFileEncodePassword) übergeben werden, fa …
@NotesIDFileReCertifyID
Diese @Funktion rezertifiziert die Notes-ID mit dem OSPATH OSPATH4 mit der Certifier Notes-ID, die dem Certifier Context Handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 zugeordnet worden ist (siehe @NotesIDFileOp …
@NotesIDFileSetCtxExpirationTD
Mit dieser @Funktion wird dem Certifier Context Handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 ein Ablaufdatum (TD TDEXPIRE2) für neu erstelle Notes-ID's zugeordnet. Alle im Folgenden mit diesem Certifier Contex …
@Now
Liefert den aktuellen Zeit-Datums-Wert. Wenn die @Function mit dem optionalem Parameter FN FN = 1 aufgerufen wird, wird die System-Zeit nicht die Domino-Server-Zeit (diese kann sich unterscheiden!) zurückgegeben.
@NTRegistryDeleteKey
Löscht den SUBKEY mit dem Namen TEXT TEXTSUBKEYNAME2 unter dem KeyPfad TEXT TEXTKEYPATH1 mit allen darin befindlichen Values. ReturnWert: Im Erfolgsfall TRUE, andernfalls @ERROR.
@NTRegistryDeleteValue
Löscht den Wert (Value) mit dem Namen TEXT TEXTVALUENAME2 unter dem KeyPfad TEXT TEXTKEYPATH1. ReturnWert: Im Erfolgsfall TRUE, andernfalls @ERROR.
@NTRegistryGetValue
Holt den Inhalt des Wert's (Value) mit dem Namen TEXT TEXTVALUENAME2, unter dem KeyPfad TEXT TEXTKEYPATH1, und gibt diesen in RETVALUE3 zurück. Der DataType von RETVALUE3 hängt vom Datentyp der Registry-Value ab. Folgend …
@NTRegistryScanSubKeys
Holt die unter dem KeyPath TEXT TEXTKEYPATH1 befindlichen SubKeys und gibt diese als HUGETEXTLIST zurück. ReturnWert: Im Erfolgsfall HUGETEXTLIST, andernfalls @ERROR.
@NTRegistryScanValues
Holt die unter dem KeyPath TEXT TEXTKEYPATH1 befindlichen Werte (Values) und gibt deren Namen als HUGETEXTLIST zurück. ReturnWert: Im Erfolgsfall HUGETEXTLIST, andernfalls @ERROR.
@NTRegistrySetValue
Setzt den Inhalt des Wert's (Value) mit dem Namen TEXT TEXTVALUENAME2, unter dem KeyPfad TEXT TEXTKEYPATH1, auf den Inhalt der Variable VALUE3. Folgende Datentypen werden unterstütz (für VALUE3): TEXT TEXTLIST NUMBER (wi …
@OpenAgent
Öffnet in der Datenbank mit dem DBHANDLE DBHANDLE1 den Agent(Filter) mit dem Namen TEXT TITLE2. Diese @Function ist erst ab Notes Version 4.5 verfügbar. ReturnWert: Wurde die @Function erfolgreich durchgeführt wird ein A …
@OpenAttachedFile
Öffnet das angehängte File mit der Attachment-Number FN FNATTACHMENTNUMBER2 oder mit dem internen (eindeutigen) Attachment-Namen TEXT TEXTATTACHMENTNAME2 und gibt einen OBJECTFILEHANDLE darauf zurück. Mit TEXT MODE3 kann …
@OpenDB
Öffnet eine Datenbank mit dem NOTESPATH NOTESPATH1 und liefert einen DBHANDLE zurück. Ab Version 1.93 kann mit TEXT OPTIONS2 ein näheres Verhalten bestimmt werden. OPTIONS2: L=Locked (Kein weiteres Öffnen von anderer Ste …
@OpenDesignNote
Öffnet das erste Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1, das der NOTECLASSES NOTECLASSES3 entspricht und den TEXT TITLE2 hat, und gibt den NOTEHANDLE NOTEHANDLE4 zurück. Hinweis: Änderungen an einem Design- …
@OpenFtSearch
Öffnet in der Datenbank mit dem DBHANDLE DBHANDLE1 einen Full-Text-Search mit dem Suchstring TEXT TEXTQUERY2 und den Optionen FN FNOPTIONS3. Der Parameter VIEWHANDLE VIEWHANDLESEARCHVIEW4 ist reserviert. Diese @Function …
@OpenNoteByID
Öffnet das Dokument in der Datenbank mit dem DBHANDLE DBHANDLE1 und der ID NOTEID2 und gibt den NOTEHANDLE NOTEHANDLE3 zurück. Über den Optionalen Parameter FN FNOPTIONS4 können Optionen angegeben werden. FNOPTIONS4: BIT …
@OpenNoteByPosition
Öffnet in der Datenbank mit dem DBHANDLE DBHANDLE1 in der Ansicht mit dem VIEWHANDLE VIEWHANDLE2 an der Position VIEWPOSITION VIEWPOSITION3 bzw. VIEWPOS VIEWPOS3 ein Dokument und gibt NOTEHANDLE NOTEHANDLE4 als Ergebnis …