Engine Help: Function
Filtered overview of the Engine Help documentation.
@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
Opens the DEVICE with the OSCOMPORTNAME OSCOMPORTNAME und outputs einen OSCOMHANDLE for it. Only for the Engine under Windows!
@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
This @Function provides a special one-way replicator with additional replace logic. It was created for a customer-specific project requirement and is not intended as a replacement for classic Domino replication. It is in …
@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.
@ReadACL
This @Function creates an in-memory copy of the ACL of the database specified by DBHANDLE DBHANDLE and returns a VSPECHACL (HACL) handle to this copy. When the VSPECHACL handle is no longer required, it must be released …
@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 …
@ReadNTComPort
Reads a value from the COM port identified by OSCOMHANDLE OSCOMHANDLE1 and returns it as the result of the @Function. The value to be read is expected to be of the type specified by TEXT RETTYPE2. Either one value is rea …
@ReadOSComPort
RETTYPE2: A=TEXT B=BINARY (currently as RICHTEXT) N=NUMBER F=FLOAT L=FLOAT (converted long) D=FLOAT (converted DWORD) T=TIMEDATE STATUS4: 0=OK 1=Read Timeout expired 2=TEXT limit reached (only in TEXT mode) 32768=Error I …
@ReadOSFile
Reads a record of length FN LENGTH3 from the OS file identified by FILEHANDLE FILEHANDLE1. This record is returned as a variable of the data type specified in TEXT RETTYPE2. If TEXT/TEXTLIST TEXT3/TEXTLIST3 is specified, …
@ReadVarOSFile
Reads a variable from the OSFILE identified by FILEHANDLE FILEHANDLE1. The variable must have been written using @WriteVarOSFile, and is returned as the @Function result. The contents of a variable, including its name an …
@RecalculateNote
NOTEHANDLE NOTEHANDLE1 Document on which the recalculation should be executed. NOTEHANDLE NOTEHANDLE2 Form design document containing the formulas and fields. NF FLAGS3 0 Report errors 1 Continue on errors Return TEXTLIS …
@ReleaseACL
This @Function releases a previously created VSPECHACL (HACL) and sets the handle contained in it to NULL. It should be called as soon as the in-memory copy of the ACL is no longer required. VSPECHACL HACL: A VSPECHACL h …
@ReleaseClass
Releases the class(es) with the name(s) TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1. Return value: @Error -> An error occurred. TRUE -> All requested classes released. FALSE -> At least one of the classes could …
@ReleaseMutexSemaphore
Releases the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE . On success, @True is returned; otherwise @ERROR. A mutex semaphore can be owned (requested) by only one task at a time. (This is u …
@RemoteConsole
Executes on the remote console of TEXT SERVER1 das Kommando TEXT COMMAND2 . On success, a TEXT is returned as the result; otherwise @ERROR with the error text.
@RenameFolder
This @Function assigns to the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2 the name TEXT NEWFOLDERNAME3. ReturnWert: If the @Function was executed successfully, TRUE is returned; othe …
@ReorgACLPrivileges
The empty elements of TEXTLIST PRIVNAMES2 are removed and returned in the parameter RETUSERPRIVS3 is returned. The corresponding privilege references in TEXTLIST USERPRIVS1 are adjusted and returned in the parameter RETP …
@ReorgList
This @Function rearranges the elements of a list and returns the newly ordered list. TEXTLIST/FNLIST/TDLIST LIST1 is the list whose elements are to be rearranged. FNLIST SEQUENCE1 specifies the new order. LIST1 and SEQUE …
@Repeat
Repeats the text in TEXT TEXT1 or in each element of TEXTLIST TEXTLIST1 until the count FN COUNT2 is reached, and optionally truncates the resulting texts after FN LENGTH3 characters.
@Replace
Replaces in TEXT/TEXTLIST TEXT1/TEXTLIST1 all elements TEXT/TEXTLIST TEXT2/TEXTLIST2 with TEXT/TEXTLIST TEXT3/TEXTLIST3. Thus, TEXT2/TEXTLIST2 specifies a list of text fragments to be replaced by text fragments from TEXT …
@ReplaceSubString
Replaces in TEXT/TEXTLIST TEXT1/TEXTLIST1 the strings specified in TEXT/TEXTLIST TEXT2/TEXTLIST2 with the corresponding element from TEXT/TEXTLIST TEXT3/TEXTLIST3. The optional parameter FN FNCMPMODE specifies the search …
@Replicate
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2. FNLIST FNLIST3 is a list of rights where the first element specifies the replication rights in the first database and the second …
@ReplicateWithFieldException
Deprecated! See @ReplicateWithFieldProtection Note : This text was machine-translated and may contain inaccuracies.
@ReplicateWithFieldProtection
Replicates the database referenced by DBHANDLE1 with the database referenced by DBHANDLE2. FNLIST3 contains the replication rights. The first element specifies the rights for replication in the first database, and the se …
@ReplicateWithFormula
Replicates the database referenced by DBHANDLE1 with the database referenced by DBHANDLE2. Only documents that match the Notes-compatible selection formula TEXT/TEXTLIST FORMULA3 are replicated. FORMULA3 can be passed as …
@ReplicateWithFormulaWithFieldException
Deprecated! See @ReplicateWithFormulaWithFieldProtection Note : This text was machine-translated and may contain inaccuracies.
@ReplicateWithFormulaWithFieldProtection
Replicates the database referenced by DBHANDLE1 with the database referenced by DBHANDLE2. Only documents that match the Notes-compatible selection formula TEXT FORMULA3 are replicated. FNLIST4 contains the replication r …
@ReplicateWithServer
The databases of the local Notes server are replicated with the remote Notes server TEXT SERVERNAME2 over the port TEXT PORTNAME1 by the Notes replicator, not by the Engine replicator. Using FN OPTIONS3, options can be s …
@RequestClass
Requests the class or classes with the name(s) TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1. Return value: @Error -> An error occurred. TRUE -> All requested classes were obtained. FALSE -> At least one of the r …
@RequestMutexSemaphore
Requests and, on success, locks the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE. On success, @True is returned; otherwise @ERROR. If FN FNTIMEOUT is specified, waiting for the mutex semapho …
@ResetVStack
Resets all variables on the VStack with the name TEXT NAME1 to the value in VAR1. If the @Function is called without the second parameter, the variables are set to the value/data type PV. Sub-VStacks located on the VStac …
@ResolveUserGroups
This @Function determines the complete name list for a specified Domino user, including all direct and indirect group memberships. The function returns a TEXTLIST whose first element is the resolved user name. The subseq …
@Reverse
Reverses the order of the characters in TEXT TEXT1 or in each element of TEXTLIST TEXTLIST1.
@Right
Returns the right part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selection can be based on FN COUNT2 characters or on the text to the right of TEXT TEXT2. The search for TEXT2 is performed from left to right.
@RightBack
Returns the right part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selection can include all characters except FN COUNT2 remaining characters, or the text to the right of TEXT TEXT2. The search for TEXT2 is performed from righ …
@RTAddButton
Appends a button labeled TEXT TEXT1 and containing the CNFORMULA CNFORMULA4 to the RichText field RT RT5. FNLIST STYLE2: 1. StyleDefinitionNumber 2. Font 3. Size 4. options 5. Color 1. StyleDefinitionNumber: Re …
@RTAddDocLink
Inserts a document link (DocLink) into the RichText field RT RTFIELD4. The link points to the document identified by NOTEHANDLE NOTEHANDLE3 in the database identified by DBHANDLE DBHANDLE1 and from the view identified by …
@RTAddFileIcon
Appends a file icon in OS/2 style to the RichText field RT RT4. TEXT1: Name of the file attachment used for display and for reference within the Notes document. This name must be unique. TEXT2: Original name of the file …