Engine Help Category: List
Filtered overview of the Engine Help documentation.
@Abs
Calculates the absolute value of FN/FNLIST FN1/FNLIST1.
@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 …
@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.
@BitAnd
Performs a bitwise logical AND on FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2 from. (A 32-bit value is used internally.)
@BitOr
Performs a bitwise logical OR on FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2 from.
@BitVektor
Returns a bit vector (NUMBER) in which the bits specified in FN/FNLIST FN1/FNLIST1 are set.
@BitXor
Performs a bitwise logical EXCLUSIVE OR on FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2 from.
@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.
@CloseQueue
Closes the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR.
@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 …
@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 …
@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 …
@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 …
@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 …
@FolderAddDoc
This @Function adds, in the DB with the DBHANDLE DBHANDLE1, the documents,whose NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 can be specified, in the Folder with the VIEWHANDLE VIEWHANDLEFOLDER2 a. Return value: If t …
@FolderRemoveDoc
This @Function removes, in the DB with the DBHANDLE DBHANDLE1, the documents whose NOTEIDs can be specified in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 from the folder with the VIEWHANDLE VIEWHANDLEFOLDER2. (The document is …
@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 …
@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.
@GetLinkListProperties
Returns the properties of the document link at the position FN POSITION2 from the VSPECLINKLIST DOCLINKLIST1. TD RETTDRID3 is the replica ID of the DB on the documents-Link verweist. (Steht hier @AnyAllDay verweist er in …
@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 …
@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 …
@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.
@GetVar
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVarWithFieldFlags
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVStackPath2GFun
Returns the prefix for the access path of a variable stored within the thread copy of a global function. This could be used, for example, to assign default values for local parameters. However, this function should be av …
@Hour
Returns the hours of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS is specified, this determines the return type. TEXT TEXTOPTIONS F=default (return data type = FLOAT/FLOATLIST) A=Retur …
@HugeTextList
Returns a variable of type HUGETEXTLIST with 0 elements.
@IDList
Returns a variable of type IDLIST with 0 elements.
@Implode
Joins TEXT/TEXTLIST TEXT1/TEXTLIST1 into a single TEXT . A space is inserted between all joined elements. With TEXT SEPTEXT2, a different separator text can be selected instead.
@InsertListElement
Inserts the element FN/TD/TEXT ELEMENT3 into the list FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST LIST1 at the position specified by FN FN2.
@Integer
Truncates the decimal places of FN/FNLIST FN1/FNLIST1 ab und gibt die ganzzahligen Werte.