Engine Help Category: Misc
Filtered overview of the Engine Help documentation.
@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 …
@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 …
@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 …
@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 …
@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 …
@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.
@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.
@StringExceptions
The string exceptions (see the StringExceptions texts) that the compiler applies to static texts are also applied by @StringExceptions to the passed TEXT TEXT1. Example @StringExceptions(TEXT1): Text:=@StringExceptions(" …
@Subset
Returns a sublist of FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/IDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/IDLIST1. If FN COUNT2 is positive, the first COUNT2 elements are returned; if COUNT2 is negative, the last COUNT2 elem …
@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 …
@Text
Converts FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/UIDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/UIDLIST1 into TEXT/TEXTLIST and returns it. For UIDLIST, the return data type is always TEXTLIST. NOTE: @Text in the Engine diffe …
@TextToDigits
Converts the ASCII characters of TEXT/TEXTLIST TEXT1/TEXTLIST1 into the corresponding ASCII-CHAR values and returns them in the form of TEXT/TEXTLIST. OPTIONS1 specifies the numeral system in which the ASCII-CHAR values …
@TextToNumber
Converts TEXT/TEXTLIST TEXT1/TEXTLIST1 into FLOAT/FLOATLIST and returns it. FN MODE2 can be used to specify the conversion mode; if it is omitted, zero is assumed. NOTE: @TextToNumber in the Engine differs slightly from …
@TextToTime
Converts the text TEXT/TEXTLIST TEXT1/TEXTLIST1 into a time-date value TD/TDLIST. TEXT TEXTOPTIONS: If "*" is specified here, the texts are expected in TD hex dump format, for example "C1255DF0:004B73DC" (corresponding t …
@TextToTimePair
Converts the text TEXT TEXT1 into a time-date pair value TDLIST. Use "-" as the separator for the time-date pair. Do not use "/" or "-" as separators between individual date components; use a period instead.
@TextToUID
Converts the text TEXT/TEXTLIST TEXT1/TEXTLIST1 into a UIDList. TEXT1 or the individual elements of TEXTLIST1 must have a length of 32 characters.
@Trim
Removes leading, trailing, and redundant spaces from TEXT/TEXTLIST TEXT1/TEXTLIST1 and returns TEXT/TEXTLIST. Empty list elements are not removed. NOTE: @Trim in the Engine differs slightly from the Notes @Function @Trim …
@TrimLeftAndRightQuote
Removes an existing quotation mark at the beginning or end of TEXT TEXT1. For TEXTLIST TEXTLIST1, this is performed for each element. Quotation marks inside TEXT TEXT1 or inside the elements of TEXTLIST TEXTLIST1 are pre …
@TrimList
Eliminates empty list elements from TEXTLIST TEXTLIST1 and returns a TEXTLIST. When called with TEXT TEXT1, the TEXT is returned unchanged. Note: A TEXTLIST consisting of n empty list elements (@BuildList("";n)) becomes …
@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 …
@UNIDList
Returns a variable of type UNIDLIST with 0 elements.
@Unique
Eliminates duplicate entries from TEXTLIST/FLOATLIST/IDLIST TEXTLIST1/FLOATLIST1/IDLIST1 and returns this cleaned-up list. For TEXT/FLOAT TEXT1/FLOAT1, this value is returned unchanged. For IDLIST, the list must first be …
@UniqueEven
Eliminates entries in TEXTLIST TEXTLIST1 that occur an odd number of times and returns this cleaned-up list. The TEXTLIST TEXTLIST1 must first have been sorted with @SortList. For TEXT TEXT1, a NULLTEXTLIST is returned.
@UniqueUnEven
Eliminates entries in TEXTLIST TEXTLIST1 that occur an even number of times and returns this cleaned-up list. The TEXTLIST TEXTLIST1 must first have been sorted with @SortList. For TEXT TEXT1, this value is returned unch …
@UpperCase
Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in uppercase. Beipiel: @UpperCase(TEXT1) TEXT1:="HeLLo woRLd !!!"; @UpperCase(TEXT1); returns "HELLO WORLD !!!"
@VerifyNoteSignature
Checks whether the document identified by NOTEHANDLE NOTEHANDLE1 is signed and whether the signature is still valid. If a signature could be positively confirmed (certified key in the address book), TRUE returned, otherw …
@VerifyPassword
Checks whether the password TEXT TEXTPASSWORD1 matches the hash TEXT TEXTHASH2; see @Password. On success, TRUE is returned; otherwise FALSE is returned.
@Weekday
Returns the weekday of TD/TDLIST TD1/TDLIST1 as a NUMBER between 1 (Sunday) and 7 (Saturday).
@Word
Returns the word at position FN/FNLIST POSITION3 from TEXT/TEXTLIST TEXT1/TEXTLIST1, using TEXT/TEXTLIST TEXT2/TEXTLIST2 to define a delimiter text that separates the words. For both TEXTLIST2 and POSITION3 in the list c …
@Year
Returns the year of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXT TEXTOPTIONS, it determines the return type. F=As without TEXT TEXTOPTIONS (return data type = FLOAT/FLOATLIST) A=Return data t …
Operator :
In principle, analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator :=
In principle, analogous to Notes. Difference: Assignment (:=) is an operator and can therefore be used in chains. IMPORTANT: Field flags are not affected by assignments.
Operator +
Analogous to Notes. Special case NULLTEXTLIST (BuildList("";0)): The behavior for NULLTEXTLIST values is defined as follows: : TEXT+NULLTEXTLIST=TEXTLIST with one element containing the value TEXT TEXTLIST+NULLTEXTLIST=T …
Operator <
Basically analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator <=
Basically analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator =
Basically analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator >
Basically analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator >=
Basically analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.