Engine Help: Function
Filtered overview of the Engine Help documentation.
@CloseMutexSemaphore
Closes the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE. On success a closed mutex semaphore-Handle (MSH) is returned, otherwise @ERROR. A mutex semaphore can be owned (requested) by only on …
@CloseNote
Closes the document with the NOTEHANDLE NOTEHANDLE1 and returns the closed NOTEHANDLE. With FN MODE2 can be used to specify more detailed behavior. MODE2: 0 = Do not save changes. 1 = Save changes. 2 = Save changes witho …
@CloseNTComPort
Only for Engine under Windows! Closes the Device with the OSCOMHANDLE OSCOMHANDLE1 and returns the closed OSCOMHANDLE.
@CloseOSComPort
Closes the Device with the OSCOMHANDLE OSCOMHANDLE1 and returns the closed OSCOMHANDLE.
@CloseOSFile
Closes the OSFILE with the FILEHANDLE FILEHANDLE1 and returns the closed FILEHANDLE.
@CloseQueue
Closes the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR.
@CloseView
Closes the view with the VIEWHANDLE VIEWHANDLE1 and returns the closed VIEWHANDLE.
@CompactDB
The DB with the NOTESPATH NOTESPATH1 is compacted. FNOPTIONS: BIT DEC HEX BEDEUTUNG 01 00001 0001 02 00002 0002 03 00004 0004 04 00008 0008 05 00016 0010 06 00032 0020 07 00 …
@Compare
comparisont PAR1 and PAR2 for binary identity. They may be of any data type. If they are identical, the result is TRUE ansonsten FALSE. NOTE: Variables of different types can also be compared, because only the binary con …
@CompareVPRList
The corresponding elements are compared in each case. (variable 1 from VPRList1 with variable 1 from VPRList2, variable 2 from VPRList1 with variable 2 from VPRList2,...) With two parameters (The comparison is performed …
@CompileFormula
Compiles TEXT1 a Notes formula text into the Notes formula compilation (CNFORMULA) and returns it. TEXT2 is required for column formulas and must contain the column item name. Example @CompileFormula(TEXT1): CNF:=@Compil …
@Contains
Determines whether in TEXT/TEXTLIST TEXT1/TEXTLIST1 the TEXT TEXT2 or an element of TEXTLIST TEXTLIST2 is contained wholly or partially and returns TRUE if this is the case. An empty TEXTLIST1, which cannot contain anyth …
@CopyACL
Copies the ACL of the database with the DBHANDLE DBHANDLE1 to the database with the DBHANDLE DBHANDLE2. If the @function was executed successfully, the @function result has the data type PV. The executing server must hav …
@CopyAttachment
Copies attachments from the opened document with the NOTEHANDLE NOTEHANDLE3 of the database DBHANDLE DBHANDLE1 to the likewise opened document NOTEHANDLE NOTEHANDLE4 of the database DBHANDLE DBHANDLE2, without considerin …
@CopyDB
Copies the database with the DBHANDLE DBHANDLE4 to a database with the NOTESPATH NOTHESPATH1 and the DBCLASS DBCLASS2 and returns a DBHANDLE to it. The documents matching the specification in NOTECLASSES NOTECLASSES6 mat …
@CopyFolder
This @function copies, in the DB with the DBHANDLE DBHANDLE1, the folder with the VIEWHANDLE VIEWHANDLEFOLDER2 as a folder named TEXT NEWFOLDERNAME3. (All documents, subfolders, and the design are copied.) Returnvalue: I …
@CopyNote
Copies the document with the NOTEHANDLE NOTEHANDLE2 to the database with the DBHANDLE DBHANDLE1 and returns the NOTEHANDLE to this new document. NOTEHANDLE3 is the NOTEHANDLE of the new document.
@CopyTemplateACL
Copies the template ACL of the database with the DBHANDLE DBHANDLE1 as the ACL into the database with the DBHANDLE DBHANDLE2. Template ACL entries are specified in the ACL in square brackets. This @function converts thes …
@CopyVStack
This @function copies all variables of the VStack with the VSTACKPATH TEXTSOURCEVSTACK to the VStack with the VSTACKPATH TEXTDESTINATIONVSTACK. If the parameter TEXT/TEXTLIST TEXTLISTVARNAMES is specified, only the varia …
@Cos
Calculates the cosine of FN/FNLIST FN1/FNLIST1.
@CountListElement
Adds to the TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 at FN POSITION2 the element TEXT/FN TEXT3/FN3 to it. In the case of TEXT1/FN1 is the only valid POSITION2 the value 1 is possible. Only elements of matching …
@CreateAttachmentFromBuffer
Creates from the content of the BINBUFFER BINBUFFER an attachment with the (internal) name TEXT TEXTNAME in the document with the NOTEHANDLE NOTEHANDLE. FN FNOPTIONS: 0 None 1 Overwrite a possibly existing attachment …
@CreateBuffer
With @CreateBuffer, a binary buffer of data type BINBUFFER is created. Return: A handle to the allocated binary buffer of data type BINBUFFER or @Error. FN FNSIZE1: Size of the binary buffer. FN FNUSEDSIZE2: Set the used …
@Created
Returns the time/date value (TD) of the creation of the document with the NOTEHANDLE NOTEHANDLE1.
@CreateDB
Creates a new completely empty database of DBCLASS DBCLASS2 under the NOTESPATH NOTESPATH1 and returns a DBHANDLE to it. With FN OVERWRITE3 can be used to specify whether an existing database with the same name should be …
@CreateDBActivity
Starts logging the user activity of the database with the DBHANDLE DBHANDLE1. If NUMBER 1 is returned if the operation was successful (or user activity already exists); otherwise ERROR.
@CreateMutexSemaphore
Creates a mutex semaphore named TEXT TEXTSEMAPHORENAME. On success, a mutex semaphore handle (MSH) is returned; otherwise @ERROR. A mutex semaphore can be owned (requested) by only one task at a time. (This is used to al …
@CreateNote
Creates a new document in the database with the DBHANDLE DBHANDLE1 for the NOTEHANDLE NOTEHANDLE2 and returns the NOTEHANDLE to it.
@CreateObjectStore
Creates a new Notes object store database with the NOTESPATH NOTESPATH1. With the parameter FN BOOLOVERWRITE2 specifies whether an already existing Notes object store database with this NOTESPATH NOTESPATH1 should be ove …
@CreateOSDirectory
Syntax 1: Creates a directory with the OSPATH OSPATH1. Syntax 2: Creates the directories specified in the OSPATHLIST OSPATHLIST1 are specified.
@CreateQueue
Creates a message queue named TEXT TEXTQUEUENAME. On success, TRUE is returned; otherwise @ERROR. A message queue is used for inter-task communication. The message queue can be opened by several tasks (see @OpenQueue) an …
@CreateQuietTask
Creates a new Engine task the the GLOBAL function named TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME executes. If @CreateQuietTask with a TEXTLIST is called as the first parameter, the first element mu …
@CreateQuietTaskNoWait
Creates a new Engine task the the GLOBAL function named TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME executes. If @CreateQuietTask with a TEXTLIST is called as the first parameter, the first element mu …
@CreateTask
Creates a new Engine task the the GLOBAL function named TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME executes. If @CreateTask with a TEXTLIST is called as the first parameter, the first element must co …
@CutList
TEXT TEXT2 is split into the lengths specified in FN/FNLIST FN1/FNLIST1 and returned as TEXTLIST is returned. If TEXTLIST TEXTLIST3 is present, in the case of 0 (NULL) in FN/FNLIST FN1/FNLIST1 the corresponding element f …
@Date
Returns the date part of TD/TDLIST TD1/TDLIST1.
@Day
Returns the day of the month of TD/TDLIST TD1/TDLIST1. If the @function is called with the parameter TEXTOPTIONS is called, this determines the return type. F=Wie ohne TEXTOPTIONS (return data type = FLOAT/FLOATLIST) A=r …
@DebugFollowFun
Defines @functions whose INPUT and OUTPUT parameters should be documented when called. It must with the KEYWORD DEBUG the mode "FOLLOW" must be activated so that the list defined with @DebugFollowFun is defined must also …
@DebugFollowVar
Defines variables that should be documented when used. It must with the KEYWORD DEBUG the mode "FOLLOW" must be activated so that the list defined with @DebugFollowVar is defined must also be taken into account. @DebugFo …
@DecompileFormula
Decompiles the binary Notes formula (CNFORMULA) CNFORMULA1 into the Notes formula text. FN2 specifies whether this is a view selection formula (=1) or not (=0). With the syntax using one parameter, it is assumed that thi …
@Decrement
Decrements FN FN1 by 1 and writes the result directly to FN1. NOTE: This @function is highly optimized and extremely fast. The @function does never return a value. The return value of the @function is undefined !!! The E …
@Define
Defines a "term" that can be used for conditional compilation. Unlike the keyword DEFINE is @Define at runtime (and only if this @Define is executed) effective. TEXT1 must not contain spaces (" ") or special characters ( …
@DeleteDB
Deletes a database with the NOTESPATH NOTESPATH1. If the returned value is NUMBER 1, the operation was successful, otherwise ERROR.
@DeleteDBActivity
Deletes the user activity of the database with the DBHANDLE DBHANDLE1. If the returned value is NUMBER 1, the operation was successful, otherwise ERROR.
@DeleteDBARConnection
Deletes a specific Advanced Replication Settings connection between the target server TEXT DESTINATIONSERVER and the source server TEXT SOURCESERVER. The entry for Anyserver (wildcard "-") as source server cannot are del …
@DeleteDBReplicaHistory
Deletes the replication history of the database with the DBHANDLE DBHANDLE1. If the returned value is NUMBER 1, the operation was successful, otherwise ERROR.
@DeleteDifferenceByFormula
Deletes documents in the database with the DBHANDLE TODBHANDLE2 which are not present in the database with the DBHANDLE FROMDBHANDLE1. It be only documents taken into account are, which have the NOTECLASS specified with …
@DeleteEnvironment
Deletes the environment variable TEXT TEXT1 physically from NOTES.INI. Returnvalue: 1 = variable could are deleted. 0 = variable not present. @Errro... = An error occurred; the variable was not deleted.
@DeleteListElement
It is from the FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST FNLIST1/TDLIST1/TEXTLIST1/IDLIST1/HUGETEXTLIST1 the element at position FN FN2 deleted.
@DeleteLogEntry
This @function determines whether the APILog document for this task should be deleted after the task has ended or not. FN FN1: DEC Meaning 32768 Delete document 0 Do not delete document 3 Query status, but do not …