Engine Help: Function
Filtered overview of the Engine Help documentation.
@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;
@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 …
@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.
@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. …
@OpenNoteByUID
Opens the document in the database with the DBHANDLE DBHANDLE1 and the UID UID2 and returns the NOTEHANDLE NOTEHANDLE3 returned. FNOPTIONS4: BIT DEC HEX Meaning if set 01 00000001 00000001 Open Summary only 0 …
@OpenNTComPort
Only for the Engine under Windows! Opens the DEVICE with the OSCOMPORTNAME OSCOMPORTNAME und outputs einen OSCOMHANDLE for it.
@OpenOSComPort
Opens the DEVICE with the OSCOMPORTNAME OSCOMPORTNAME und outputs einen OSCOMHANDLE for it.
@OpenOSFile
Opens the OSFILE with the OSPATH OSPATH1 und outputs einen FILEHANDLE for it. TEXT MODE2 can be used to specify the open mode. MODE2: A=(Append) Open for appending data B=(Binary) No conversion from CR to CRLF or vic …
@OpenProfileNote
Opens a profile document in the DB with the DBHANDLE DBHANDLE1 and returns the opened NOTEHANDLE NOTEHANDLE3 for this profile document. TEXT/TEXTLIST TEXT2/TEXTLIST2: If only a TEXT is specified, this is the profile form …
@OpenQueue
Opens the message queue named TEXT TEXTQUEUENAME. On success, a queue handle is returned; otherwise @ERROR.
@OpenView
Opens in the database with the DBHANDLE DBHANDLE1 a view/folder named TEXT NAME2 (or with the NOTEID VIEWNOTEID) and returns the VIEWHANDLE returned. Options can be specified in the parameter FN FNFLAGS3 can be used to s …
@Password
Generates from TEXT TEXTPASSWORD1 a hash, which is returned as TEXT . In case of an error, @Password @Error is returned. FN FNHASHTYPE2: 1 returns a hash like @Password in Notes. (Version compatible with Notes version >= …
@Power
Calculates FN/FNLIST FN1/FNLIST1 to the power of FN/FNLIST FN2/FNLIST2. Each element of FNLIST2 is applied to the corresponding element of FNLIST1 . If one list is shorter, its last element is used for all missing elemen …
@ProperCase
Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in proper case, i.e. the first letter is uppercase and the following letters are lowercase.
@PrtVStack
Outputs the VStack with dem names NAME1 (if "" is specified, _PRCVSTACK - the local VStack of this function or context - is used). With FN OPTIONS2 the detailed behavior can be specified, and with FN SIZE3 a maximum size …
@PushAndReplace
Replicates the database with the DBHANDLE FROMDBHANDLE1 with the database with the DBHANDLE TODBHANDLE2 in the direction from FROMDBHANDLE1 to TODBHANDLE2, replicating only the documents that match the Notes-compatible s …
@PushWithFormula
Replicates the database with the DBHANDLE FROMDBHANDLE1 with the database with the DBHANDLE TODBHANDLE2 in the direction from FROMDBHANDLE1 to TODBHANDLE2, replicating only the documents that match the Notes-compatible s …
@PutQueue
Places the message TEXT TEXTMESSAGE with priority FN FNPRIORITY into the message queue with queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR. FN FNPRIORITY: 1 = Highest priority …
@Rand
Currently available only under NT! Returns a pseudo-random number between 0 and 32767.
@ReadAttachedFile
Reads a record of length FN LENGTH3 from the file attachment identified by OBJECTFILEHANDLE OBJECTFILEHANDLE1. This record is returned as a variable of the data type specified by TEXT RETTYPE2. If TEXT/TEXTLIST TEXT3/TEX …
@ReadBuffer
Liest aus dem BINBUFFER with dem BUFFERHANDLE BUFFERHANDLE1 a record with length FN LENGTH3. This record is returned as a variable of the data type specified in TEXT RETTYPE2 . RETTYPE2: A=TEXT B=BINARY (derzeit as RICHT …