Engine Help Category: List
Filtered overview of the Engine Help documentation.
@IPHexDump2DecAdr
Converts V4 IP address(es) in HEX dump notation (TEXT/TEXTLIST TEXT1/TEXTLIST1) into IP address(es) in decimal dotted notation and returns them. HEXDump Notation: An IP address may be 7 or 8 characters long. If it has 7 …
@IsMember
Returns whether TEXT/TEXTLIST TEXT1/TEXTLIST1 is completely contained in TEXT/TEXTLIST TEXT2/TEXTLIST2. If TEXTLIST1 contains no elements, the result depends on whether TEXTLIST2 contains any elements: if TEXTLIST2 is em …
@IsNotMember
Returns 1 if TEXT/TEXTLIST TEXT1/TEXTLIST1 is not completely contained in TEXT/TEXTLIST TEXT2/TEXTLIST2; otherwise returns 0. If TEXTLIST1 contains no elements, the result depends on whether TEXTLIST2 contains any elemen …
@JoinList
Implodes TEXT/TEXTLIST TEXTLIST1 taking into account FN/FNLIST LENGHTLIST2 and the separator string list TEXT/TEXTLIST SEPERATORLIST3 zu einem TEXT. FN/FNLIST LENGHTLIST2: Assigns a length to each element of TEXT/TEXTLIS …
@Left
Returns the left part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selected part can be FN COUNT2 characters or the text to the left of TEXT TEXT2. The search for TEXT2 is performed from left to right.
@LeftBack
Returns the left part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selected part can be all characters except for FN COUNT2 remaining characters, or the text to the left of TEXT TEXT2. The search for TEXT2 is performed from rig …
@Length
Returns the length of VAR VAR1, or the lengths of the individual elements of VARLIST VARLIST1.
@Ln
Calculates the natural logarithm of FN/FNLIST FN1/FNLIST1.
@Log
Calculates the base-10 logarithm of FN/FNLIST FN1/FNLIST1.
@LogReport
Outputs the contents of the variable VAR1 to the API log and on the server console. With FN OPTIONS2 the detailed behavior of the @Function can be defined. FNLIST STYLE3 specifies the font, options, color and size of the …
@LowerCase
Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in lowercase.
@MagicNumber
Returns a MagicNumber for the value FN FN1.
@Max
Returns the maximum of FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2. To do this, each element of FNLIST1 is compared with the corresponding element of FNLIST2. If one list is shorter, its last element is used for all …
@MaxPos
Returns the position of the first occurrence of the largest element in FN/FNLIST FN1/FNLIST1. By specifying FN FROM2 and FN TO3 a search range can be defined. If it exceeds the list size, it is reduced to the maximum pos …
@Member
Returns the position at which TEXT/FN TEXT1/FN1 in TEXT/TEXTLIST/IDLIST TEXT2/TEXTLIST2/IDLIST2 is contained in TEXTLIST1/IDLIST1 contains no elements, the result is 0. If @Member is called with PositionList3 then the pa …
@Middle
Returns FN LENGTH3 characters from inside TEXT/TEXTLIST TEXT1/TEXTLIST1. A start position can be selected FN POSITION2 (starting at 0!) or a TEXT TEXT2 can be specified as the position. Note that TEXT2 is not included in …
@MiddleBack
Returns FN LENGTH3 characters from inside TEXT/TEXTLIST TEXT1/TEXTLIST1. A start position can be selected FN POSITION2 (starting at 0!) or a TEXT TEXT2 can be specified as the position. Note that TEXT2 is not included in …
@Min
Returns the minimum of FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2. To do this, each element of FNLIST1 is compared with the corresponding element of FNLIST2. If one list is shorter, its last element is used for all …
@MinPos
Returns the position of the first occurrence of the smallest element in FN/FNLIST FN1/FNLIST1. By specifying FN FROM2 and FN TO3 a search range can be defined. If it exceeds the list size, it is reduced to the maximum po …
@Minute
Returns the minutes of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = …
@Modulo
Calculates the remainder of the integer division of FN/FNLIST FN1/FNLIST1 durch FN FN2. Decimal places are ignored and no negative remainders are returned; therefore FN1/FNLIST1 and FN2 should be positive integers.
@Month
Returns the month of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = TE …
@Name
Basically analogous to Notes. Difference: The KEYWORD must be enclosed in quotation marks: Therefore, instead of [CN] "[CN]" must be specified etc. KEYWORD: [O] [C] [OU1] [OU2] [OU3] [OU4] [CN] [Canonicalize] [Abbreviate …
@Neg
Negates FN/FNLIST FN1/FNLIST1, and returns the result as FLOAT/FLOATLIST.
@Newline
Returns a line break that can be used in TEXT/TEXTLIST can be used.
@OpenQueue
Opens the message queue named TEXT TEXTQUEUENAME. On success, a queue handle is returned; otherwise @ERROR.
@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.
@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 …
@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 …
@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 …
@Second
Returns the seconds of TD/TDLIST TD1/TDLIST1 value. If the @Function is called with the parameter TEXTOPTIONS , it determines the return type. F=like without specifying TEXTOPTIONS (return data type = FLOAT/FLOATLIST) A= …
@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 …
@SetLinkListProperties
Sets the properties of the document link at position FN POSITION2 in the VSPECLINKLIST DOCLINKLIST1. TD TDRID3 is the replica ID of the DB to which the document link should point. (If @AnyAllDay is specified here, the do …
@SetListElement
Replaces the element at FN POSITION2 of FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/IDLIST/HUGETEXTLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/IDLIST1/HUGETEXTLIST1 with FN3/TEXT3/TD3 and returns the new list as the result. In th …
@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.
@SetProfileField
Sets the content of the profile field named TEXT TEXTFIELDNAME, for the user named TEXT TEXTUSERNAME (may also be ""), using the profile form named TEXT TEXTPROFILEFORMNAME from the database identified by DBHANDLE DBHAND …
@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 …
@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 …
@ShiftList
Shifts the FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1 in the direction FN DIRECTION3, sets the vacated position to FN/TEXT/TD FN2/TEXT2/TD2 and removes the element at the other end of the l …
@Sin
Calculates the sine of FN/FNLIST FN1/FNLIST1.
@SortList
Sorts the TEXT/TEXTLIST TEXT1/TEXTLIST1 and returns this sorted list. Optionally, a reorganization list NUMBERLIST SEQUENCE1 can be returned. It can be used with @ReorgList to put other lists into the same order into whi …
@Soundex
Returns a numeric code for TEXT/TEXTLIST TEXT1/TEXTLIST1 that enables a homophonic (similar-sounding) comparison. It is mainly used in the address book.