Engine Help Category: Misc
Filtered overview of the Engine Help documentation.
@Adjust
Changes the individual components of the time/date value TD/TDLIST TD1/TDLIST1 by the values specified in FN YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 . YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 is added to year/month/day/ho …
@AllDay
Returns the time/date value (TD) for any time. A comparison with any time is always TRUE.
@AnyAllDay
Returns the time/date value (TD) for any date and time. A comparison with any other time/date value is always TRUE.
@AnyDay
Returns the time/date value (TD) for any date. A comparison with any other date is always TRUE.
@Author
Essentially analogous to Notes. If a field with the Notes V2.0/V2.1 Author data type is passed, the text part of this data type is returned as text. Note : This text was machine-translated and may contain inaccuracies.
@Beep
Generates a beep on the server console.
@BitVektor
Returns a bit vector (NUMBER) in which the bits specified in FN/FNLIST FN1/FNLIST1 are set.
@BuildList
Creates a list with FN COUNT2 identical elements FN/TEXT/TD/ID FN1/TEXT1/TD1/ID1.
@BuildNamedDocKeyLists
This @Function creates two corresponding lists (HUGETEXT RETHTL and IDLIST RETIDL). In the list HUGETEXT RETHTL the contents of the fields are returned sorted alphabetically, from the documents specified by the selection …
@Char
Converts the ASCII code specified in FN/FNLIST FN1/FNLIST1 specified ASCII code into the corresponding character, or into a list of characters.
@CheckDefine
Checks whether a "term" (which can be used for conditional compilation) is defined or not. If the "term" is defined, @CheckDefine NUMBER 1 (TRUE) back. If the "term" is not defined, @CheckDefine NUMBER 0 (FALSE) back. TE …
@CheckHandle
Checks whether VIEWHANDLE/NOTEHANDLE/DBHANDLE/FILEHANDLE... VIEWHANDLE1/NOTEHANDLE1/DBHANDLE1/FILEHANDLE1... is an open handle. If yes, TRUE returned, otherwise FALSE. FILEHANDLE can only be checked as of version 1.93.
@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 …
@CloseQueue
Closes the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR.
@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 …
@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 …
@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 …
@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 …
@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 …
@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 ( …
@DeleteListElement
It is from the FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST FNLIST1/TDLIST1/TEXTLIST1/IDLIST1/HUGETEXTLIST1 the element at position FN FN2 deleted.
@DigitsToText
Converts the ASCII-CHAR values in TEXT/TEXTLIST TEXT1/TEXTLIST1 to the corresponding ASCII texts and returns them as TEXT/TEXTLIST. The second parameter specifies the number system in which the ASCII-CHAR values in TEXT1 …
@DocLength
Returns the size of the document with the NOTEHANDLE NOTEHANDLE1 (object size of the document without attachments). If @DocLength is used in the second format, the lengths of the contents of the fields (and the attachmen …
@Elements
Returns the number of elements of FNLIST/TEXTLIST/TDLIST/IDLIST FNLIST1/TEXTLIST1/TDLIST1/IDLIST. If no list is passed to the @Function as an argument, the @Function result is 1.
@ExpandGroups
In TEXT/TEXTLIST TEXT1/TEXTLIST1, all specified group names are replaced by their members. Unknown group names are retained, and the resulting list is returned as the @Function result. TEXTLIST TEXTLIST2 additionally ret …
@Explode
Splits the TEXT/TEXTLIST TEXT1/TEXTLIST1 into a TEXTLIST. At each occurrence of a space, the TEXT1 or each element of TEXTLIST1 is separated and made into its own element. TEXT SEPTEXT2 can be used to specify a different …
@FloatToNumber
Converts FN FN1 or FNLIST FNLIST1 into a NUMBER or NUMBERLIST; any existing decimal places are truncated. HINWEIS:NOTE: All numeric constants in the APIEngine are of type FLOAT/FLOATLIST. ACHTUNG:IMPORTANT: The range of …
@GetDataType
Returns the data type of the variable VAR1. Data type: Return value: TEXT A TEXTLIST AL NUMBER N NUMBERLIST NL FLOAT F FLOATLIST FL TD T TDLIST TL RT (RICHTEXT) RT ID I IDLIST IL UNIDLIST …
@GetEngineTasks
Returns a list (TEXTLIST) the Engine tasks active when the @function is called.
@GetFieldFlags
Returns the Notes field flags of a varifromle. Field-Flags: 1 SIGN 2 SEAL 4 SUMMARY 16 SEALED 32 READ/WRITE-ACCESS 64 NAMES 256 PLACEHOLDER 512 PROTECTED 1024 READ-ACCESS Practical examples of combinati …
@GetLastNotesErrorCode
Returns the Notes error code of the last Notes function of this task as FN. (This can therefore aso be NOERROR=0.) See aso @GetNotesErrorString.
@GetListElement
Returns the element an FN/FNLIST POSITION2/POSITIONLIST2 of FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/ID/IDLIST/HUGETEXTLIST/UNIDLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/ID1/IDLIST1/HUGETEXTLIST1/UNIDLIST1, where in the case …
@GetOSFileCreated
Returns the creation time of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD value for the cr …
@GetOSFileModified
Returns the time of the last modification of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD …
@GetOSPath
Returns the physical/local path (OSPATH) for the relative NOTESPATH/NOTESPATHLIST NOTESPATH1/NOTESPATHLIST1. Directory and database links are taken into account. If a NOTESPATHLIST is passed as the input parameter, error …
@GetProfileField
Returns the contents of the profile field named TEXT TEXTFIELDNAME, for the user named TEXT TEXTUSERNAME (which may also be ""), taking into account the Profile-Form with the name TEXT TEXTPROFILEFORMNAME from the databa …
@GetQueue
Gets the next message from the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, the message (TEXT) is returned, otherwise @ERROR (one-parameter version only, otherwise "" (NULLSTRING)). FN FN …
@GetServerStats
Gets the statistics entries of the server TEXT TEXT1 and returns them as TEXTLIST is returned. With the optional parameter TEXT TEXT2 the facility can be restricted so that only entries from this area are returned. With …
@GetSessionID
Returns a new SessionID.
@GetThreadID
Returns the ThreadID (FN) of the thread whose script executes this @Function. The optional parameter FN FNTYPEOFTASKID determines whether the operating-system ThreadID or the Engine-internal TaskID (shown, for example, b …
@GetThreadIDText
Returns the ThreadID of the thread as TEXT whose script executes this @Function.