Engine Help Category: Float
Filtered overview of the Engine Help documentation.
@Abs
Calculates the absolute value of FN/FNLIST FN1/FNLIST1.
@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.
@BoolNeg
Negiert FN/TEXT FN1/TEXT1; the result is always of type NUMBER is. When using TEXT1 an empty text is equivalent to FALSE and any non-empty text is equivalent to TRUE.
@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 …
@CacheLogReport
Aktiviert or deaktiviert abhaengig vom Argument FN STATE1 buffering of LogReport statements (including @LogReport). The @Function returns the activation state of buffering as the result. STATE1: 0 = buffering off. 1 = bu …
@CacheLogReportUpdateInterval
Sets the interval (FN1) at which, when @CacheLogReport is enabled, the APILog entry is updated. @CacheLogReportUpdateInterval always returns the current interval. (For FN1=0 only the current interval is returned.)
@Char
Converts the ASCII code specified in FN/FNLIST FN1/FNLIST1 specified ASCII code into the corresponding character, or into a list of characters.
@Clock
Returns the milliseconds elapsed since the Engine was started.
@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 …
@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 …
@Decrement
Decrements FN FN1 by 1 and writes the result directly to FN1. NOTE: This @function is highly optimized and extremely fast. The @function does never return a value. The return value of the @function is undefined !!! The E …
@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.
@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 …
@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 …
@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 …
@Increment
Increments FN FN1 by 1 and writes the result directly back to FN1. NOTE: This @Function is very fast, but it does not return a function result even on success. The return value of the @Function is undefined!!! The expres …
@Integer
Truncates the decimal places of FN/FNLIST FN1/FNLIST1 ab und gibt die ganzzahligen Werte.
@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 …
@IsBitSet
Checks whether the bit at position FN FN2 in FN FN1 is set or not. If it is set, TRUE is returned; otherwise FALSE. The position is counted from the back and starts with 1. Examples: @IsBitSet(FN1;FN2); X:=1; Ret:=@IsBit …
@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 …
@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 …
@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 …
@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 …
@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.
@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.
@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 …
@Rand
Currently available only under NT! Returns a pseudo-random number between 0 and 32767.
@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 …
@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 …
@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 …