Engine Help Category: System
Filtered overview of the Engine Help documentation.
@HexDumpToBin
@HexDumpToBin converts the hex stream dump in TEXT/BINBUFFER VAR1 into a binary buffer. Whitespace is ignored. Using TEXT TEXTRETTYPE2 it can be specified whether the returned binary data is returned as RT or as BINBUFFE …
@HookUpdateFields
With this @Function, the fields changed by the Engine script of the global HOOK function of the document with the NOTEHANDLE NOTEHANDLE1 are transferred back into the document.
@MainDatabase
Without parameters, @MainDatabase the DBHANDLE for the current main database (AEF DATABASE Statement). With parameters, @MainDatabase works like @OpenDB, but the opened database becomes the new main database. The previou …
@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 …
@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 …
@Rand
Currently available only under NT! Returns a pseudo-random number between 0 and 32767.
@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 …
@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 …
@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 …
@SaveMain
Only within IDF: Negates the general setting for saving the MAIN documentes. See IDF document SECTION SYSTEM.
@ScanVStack
Returns all variables on the VStack with the name TEXT NAME1 als TEXTLIST as a TEXTLIST. variables of the data types PV und UA are not taken into account. If only "" is specified for NAME1 , the variables from _PRCVSTACK …
@SetFieldFlags
Sets the field flags FN2 for Notes in a variable. If a variable is not explicitly assigned flags using @SetFieldFlags, the default values are assumed. However, if flags have been assigned, those flags always apply. Field …
@SetLocalServerTime
Sets the Domino server time. IMPORTANT: Changing the Notes server time may cause side effects. This is especially true if the time is moved back into the past. For example, documents may disappear until the time at which …
@SetLogDocField
Sets a field named TEXT TEXT1 and with the content TEXT/TEXTLIST/FN/FNLIST/TD/TDLIST TEXT2/TEXTLIST2/FN2/FNLIST2/TD2/TDLIST2 in the current APILog document.
@SetPosBuffer
Sets the position in the BINBUFFER with BUFFERHANDLE BUFFERHANDLE1 to the values specified in FN POSITION2 (in bytes), taking into account mode TEXT MODE3. MODE3: S=Calculated from the start of the BINBUFFER C=Current po …
@SetTaskTimeout
Enables task timeout monitoring for the task that calls @SetTaskTimeout. FN FN1 specifies the time, in seconds, that the task may still take after the @Function call until the next call to @SetTaskTimeout oder @ClearTask …
@SetVar
Sets the value of the variable(s) named TEXT/TEXTLIST NAME1 to the value VAR3. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be specified as …
@SetVarFieldFlags
Sets the Notes field flags for the field specified in TEXT NAME1 to the value FN FN1. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be specif …
@SetVarInVar
Inserts into the variable VARDEST1 at position FN POSITION2 from the variable VARSOURCE2 starting at position FN POSITION4 FN LENGTH bytes and returns the result. With TEXT MODE6 the insertion mode can be specified in mo …
@SetVarWithFieldFlags
Sets the value of the variable(s) with the name(s) TEXT/TEXTLIST NAME1 to the value VAR3. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be sp …
@Shell
Executes the OS/2 shell commands in TEXT COMMAND1 and returns the return status.
@Sleep
Pauses execution of the current script for FN COUNT1 tenths of a second. Since this uses an idle wait that does not occupy the processor, this function is always preferable to an empty counting loop.
@SleepMS
Pauses execution of the current script for FN COUNT1 milliseconds. Since this uses an idle wait that does not occupy the processor, this function is always preferable to an empty counting loop.
@SwitchLogDoc
After this @Function has been called, the log is continued in a new subsequent APILOG document. Example @SwitchLogDoc: @LogReport("document 1"); @SwitchLogDoc; @LogReport("document 2"); The line "document 1" is output in …
@TaskShouldStop
Returns 1 as the @Function result if the Engine should terminate, for example because the Notes server is being shut down. This function can be used as an abort condition for very long loops or endless loops that may occ …
@Today
Returns the current date.
@Tomorrow
Returns the date of the next day.
@Unavailable
Deletes a variable in a document or a VARGROUP by returning the value UV Unavailable when it is used as the right-hand value of an assignment.
@Undefine
Deletes a defined "term" that can be used for conditional compilation. In contrast to the keyword UNDEFINE, @Undefine takes effect at runtime, and only if this @Undefine is executed. TEXT1 must not contain spaces (" ") o …
@WriteBuffer
Writes the contents of a variable from the current position; see @GetPosBuffer/@SetPosBuffer, to the BINBUFFER identified by BUFFERHANDLE BUFFERHANDLE1. Currently, the following data types are supported for VAR2: TEXT TE …
@Yesterday
Returns the date of the previous day.
TELL Engine Commands
On the server console, instructions can be issued to the Engine or to individual Engine tasks using the TELL command. Command: Meaning: do compact Manually starts an API log compaction. stop TASKID Signals to the t …