Engine Help: Function
Filtered overview of the Engine Help documentation.
@MoveFolder
This @Function moves the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2, under the folder mit the VIEWHANDLE VIEWHANDLEPARENTFOLDER3. The folders must be of the same type (shared/privat …
@MySQLClose
Closes a VSPECMYSQL MySQLHandle. The VSPECMYSQL MySQLHandle is returned by @MySQLInit. Return: On success, a closed VSPECMYSQL MySQLHandle; otherwise @Error.
@MySQLClosePreparedStatement
Closes a MySQLPreparedStatementHandle. Return: On success, a closed PreparedStatement handle; otherwise, @Error.
@MySQLConnect
Establishes a connection to the MySQL server. Should be called after @MySQLoptions. The VSPECMYSQL MySQLHandle is provided by @MySQLInit. TEXT Host (for local "" (NULLSTR)) TEXT User (may also be "" (NULLSTR)) TEXT Passw …
@MySQLCreatePreparedStatement
Creates a PreparedStatement query. Such a query represents a kind of template that can then be completed with data to form a complete query and executed. This function is intended for repeated execution of similar querie …
@MySQLExecutePreparedStatement
Executes a prepared query using the MySQLPreparedStatementHandle. After the handle, the parameters are specified in the order corresponding to the query. Return: TRUE on success, otherwise @Error. WARNING: The MySQLPrepa …
@MySQLFetchColumn
Retrieves a column from the stored result of an @MySQLQuery request. The column number is specified in FN FNColumnNumber. If the optional parameter FN FNVPR is specified, the result is additionally returned in the variab …
@MySQLFetchColumnLocalTD
Retrieves a column from the stored result of an @MySQLQuery request. The column number is specified in FN FNColumnNumber. Time values are converted to the local time zone. (This is a workaround function for time zone iss …
@MySQLFetchRow
Fetches one row from the current position (see @MySQLSeekResult) of a stored result of a @MySQLQuery query. The VSPECMYSQLRES MySQLResultHandle is provided by @MySQLQuery. After the current row has been retrieved using t …
@MySQLFreeResult
Deletes a stored result of an @MySQLQuery request. The VSPECMYSQLRES MySQLResultHandle is returned by @MySQLQuery. Return: On success, a closed VSPECMYSQLRES MySQLResultHandle is returned; otherwise @Error;
@MySQLGetAffectedRows
Returns the number of rows affected by the last @MySQLQuery call. This function should be called immediately after @MySQLQuery and with the MySQLResultHandle variable, or, if no result is retrieved, with the MySQLHandle …
@MySQLGetAffectedRowsPreparedStatement
If the query contains an INSERT, UPDATE, or DELETE statement, the number of rows affected by this statement is returned. Return: On error, @Error; otherwise, the retrieved value.
@MySQLGetFieldDef
Returns detailed information about a field definition (for a column) in the stored result of an @MySQLQuery request. The field number is specified in FN FieldIndex, starting with 0. RetName TEXT Name of the field. RetTyp …
@MySQLGetInsertID
Returns the generated ID of an AUTOINCREMENT ID column if the last @MySQLQuery call generated such an AUTOINCREMENT ID. This function should be called immediately after @MySQLQuery and with the same MySQLHandle variable. …
@MySQLGetLastInsertIDPreparedStatement
If the query contains an INSERT statement and affects an AUTO_INCREMENT ID column, the generated ID is returned. Return: On error, @Error; otherwise, the retrieved value.
@MySQLGetNumFields
Returns the number of fields (columns) in the stored result of an @MySQLQuery or @MySQLExecutePreparedStatement request. Return: On success, the number of fields; otherwise, @Error.
@MySQLGetNumRows
Returns the number of rows of a stored result of a @MySQLQuery or @MySQLExecutePreparedStatement query. Return: On success FN Count, otherwise @Error;
@MySQLInit
Initializes MySQL and returns a VSPECMYSQL MySQLHandle; this is required by other MySQL @Functions. Return: On success, returns a VSPECMYSQL MySQLHandle, otherwise @Error;
@MySQLOptions
Sets the options. Should be called after @MySQLInit. Currently, only the option MYSQL_READ_DEFAULT_GROUP is set. If only one parameter is specified, this value is set to "engine"; otherwise it is set to the specified TEX …
@MySQLQuery
Executes a MySQL query. If the query returns a result, it can be stored in the VSPECMYSQLRES MySQLResultHandle. If the query contains an INSERT statement and it affects an AUTOINCREMENT ID column, the generated ID is ret …
@MySQLSeekResult
Sets the current position, respectively row, in a stored result of an @MySQLQuery request. WARNING: Counting starts at 0! Return: TRUE on success, otherwise @Error.
@MySQLThreadEnd
This @Function must be called before a thread is terminated! NOTE: This @Function releases the MySQL context! After calling @MySQLThreadEnd, no further MySQL functions may be called.
@MySQLThreadInit
Initializes a thread for MySQL. @MySQLInit or @MySQLConnect also initialize a thread. Note : This text was machine-translated and may contain inaccuracies.
@Name
Basically analogous to Notes. Difference: The KEYWORD must be enclosed in quotation marks: Therefore, instead of [CN] "[CN]" must be specified etc. KEYWORD: [O] [C] [OU1] [OU2] [OU3] [OU4] [CN] [Canonicalize] [Abbreviate …
@Neg
Negates FN/FNLIST FN1/FNLIST1, and returns the result as FLOAT/FLOATLIST.
@Newline
Returns a line break that can be used in TEXT/TEXTLIST can be used.
@NewOID
Returns a OID for a new document in a database with the DBHANDLE DBHANDLE1.
@NotesIDFileCloseCertifierCtx
The @Funktion closes the Certifier NotesID Context-Handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 and returns VSPECPOTVAR. Return value: On success VSPECPOTVAR is returned; otherwise @ERROR.
@NotesIDFileEncodePassword
The @Funktion encodes the plain-text password TEXT TEXTPASSWORD1 and returns the encoded password as VSPECENCPASSWORD. In case of an error, @ERROR is returned.
@NotesIDFileGetInfo
This @Funktion returns various information about the Notes ID file with the OSPATH OSPATH1. If the ID file is password-protected, @NotesIDFileGetInfo should not be used. In that case, the password is requested on the ser …
@NotesIDFileNewCertifier
Creates a new Notes certifier ID. Optionally, an entry can also be created in the Name and Address Book, and a mail file can be created for the new user. The process is controlled primarily by FN IDTYPE and FN FLAGS. All …
@NotesIDFileNewServer
Creates a new Notes server ID. Optionally, an entry can also be created in the Name and Address Book. The process is controlled primarily by FN IDTYPE and FN FLAGS. All other parameters are largely optional TEXT paramete …
@NotesIDFileNewWorkstation
Creates a new Notes ID. Optionally, an entry can also be created in the Name and Address Book, and a mail file can be created for the new user. The process is controlled primarily by FN IDTYPE, FN MAILSYSTEM and FN FLAGS …
@NotesIDFileOpenCertifierCtx
This @Funktion öffnet the Cdertifier Context (Certifier Notes ID) with the OSPATH OSPATH1. In parameter VSPECENCPASSWORD VSPECENCPASSWORD2 the encoded password must (see @NotesIDFileEncodePassword) be passed, if the Note …
@NotesIDFileReCertifyID
This @Funktion recertifies the Notes ID with the OSPATH OSPATH4 of the certifier Notes ID that is assigned to the certifier context handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 has been assigned (see @NotesIDF …
@NotesIDFileSetCtxExpirationTD
With this @Funktion the certifier context handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 an expiration date (TD TDEXPIRE2) for newly created Notes IDs. All IDs subsequently created with this certifier context ha …
@Now
Returns the current date/time value. If the @Function with the optional parameter FN FN = 1 is called, the system time is returned instead of the Domino server time (these may differ!).
@NTRegistryDeleteKey
Deletes the SUBKEY named TEXT TEXTSUBKEYNAME2 under the key path TEXT TEXTKEYPATH1 together with all values contained in it. Return value: On success TRUE, otherwise @ERROR.
@NTRegistryDeleteValue
Deletes the value named TEXT TEXTVALUENAME2 under the key path TEXT TEXTKEYPATH1. Return value: On success TRUE, otherwise @ERROR.
@NTRegistryGetValue
Retrieves the content of the value named TEXT TEXTVALUENAME2, under the key path TEXT TEXTKEYPATH1 and returns it in RETVALUE3 returned. The data type of RETVALUE3 depends on the data type of the registry value. The foll …
@NTRegistryScanSubKeys
Retrieves the TEXT TEXTKEYPATH1 subkeys located under the key path and returns them as HUGETEXTLIST returned. Return value: On success HUGETEXTLIST, otherwise @ERROR.
@NTRegistryScanValues
Retrieves the TEXT TEXTKEYPATH1 values located under the key path and returns their names as HUGETEXTLIST returned. Return value: On success HUGETEXTLIST, otherwise @ERROR.
@NTRegistrySetValue
Sets the content of the value named TEXT TEXTVALUENAME2, under the key path TEXT TEXTKEYPATH1, to the content of the variable VALUE3. The following data types are supported (for VALUE3): TEXT TEXTLIST NUMBER (set as DWOR …
@OpenAgent
Opens in the database with the DBHANDLE DBHANDLE1 the agent/filter named TEXT TITLE2. This @Function is available only as of Notes version 4.5. Return value: If the @Function is executed successfully, an AGENTHANDLE is r …
@OpenAttachedFile
Opens the attached file with attachment number FN FNATTACHMENTNUMBER2 or with the internal (unique) attachment name TEXT TEXTATTACHMENTNAME2 und outputs einen OBJECTFILEHANDLE for it. TEXT MODE3 can be used to specify th …
@OpenDB
Opens a database with the NOTESPATH NOTESPATH1 and liefert einen DBHANDLE returned. As of version 1.93, TEXT OPTIONS2 can be used to specify more detailed behavior. OPTIONS2: L=Locked (no further opening from another loc …
@OpenDesignNote
Opens the first document in the database with the DBHANDLE DBHANDLE1, that matches the NOTECLASSES NOTECLASSES3 matches and has the TEXT TITLE2 and has the specified title, and returns the NOTEHANDLE NOTEHANDLE4 returned …
@OpenFtSearch
Opens in the database with the DBHANDLE DBHANDLE1 a full-text search with the search string TEXT TEXTQUERY2 and the options FN FNOPTIONS3. The parameter VIEWHANDLE VIEWHANDLESEARCHVIEW4 is reserved. This @Function is ava …
@OpenNoteByID
Opens the document in the database with the DBHANDLE DBHANDLE1 and the ID NOTEID2 and returns the NOTEHANDLE NOTEHANDLE3 returned. Options can be specified using the optional parameter FN FNOPTIONS4 can be used to specif …
@OpenNoteByPosition
Opens in the database with the DBHANDLE DBHANDLE1 in the view with the VIEWHANDLE VIEWHANDLE2 an the Position VIEWPOSITION VIEWPOSITION3 bzw. VIEWPOS VIEWPOS3 a document and outputs NOTEHANDLE NOTEHANDLE4 as the result. …