Engine Help Category: Misc
Filtered overview of the Engine Help documentation.
@GetTickCount
Returns the milliseconds (ms) elapsed since system startup as FN is returned. The resolution depends on the system and is typically between 10 and 16 ms.
@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 …
@GetVarFromVar
Returns the variable TEXT/RT/FN/TD TEXT1/RT1/FN1/TD1 ab Position FN FN2 for FN FN3 characters. In TEXT TYPE4 specifies the data type as which the return value is to be interpreted. RETTYPE4: A=TEXT B=Binär (RT) F=FLOAT N …
@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 …
@HashPassword
Generates a hash from TEXT TEXTPASSWORD1 and returns it as TEXT. In case of an error, @HashPassword returns @Error. This @Function generates a hash that is compatible with a hash generated by the @Function @Password usin …
@HookUpdateFields
With this @Function, the fields changed by the Engine script of the global HOOK function of the document with the NOTEHANDLE NOTEHANDLE1 are transferred back into the document.
@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.
@If
Evaluates 1 to 49 conditions BOOL Condition1..49 and returns as the result the value from TrueValue1..49 that immediately follows the first matching condition Condition1..49 . If no condition Condition1..49 matches, the …
@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.
@IndexOf
Determines whether, in TEXT/BUFFERHANDLE TEXTINSTRING/BUFFERHANDLE der TEXT/the elements of TEXTLIST TEXTSEARCH is/are contained and, if so, at which position(s) it/they are located. The position starts at 0. If the TEXT …
@InsertListElement
Inserts the element FN/TD/TEXT ELEMENT3 into the list FNLIST/TDLIST/TEXTLIST/IDLIST/HUGETEXTLIST LIST1 at the position specified by FN FN2.
@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 …
@IsError
Checks whether any of the variables VAR1-VAR99 contains an error status and returns TRUE if this is the case; otherwise FALSE. IMPORTANT: This @Function returns TRUE if one of the variables VAR1-VAR99 are of Type TEXT st …
@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.
@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.
@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 …
@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 = …
@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 …
@Newline
Returns a line break that can be used in TEXT/TEXTLIST can be used.
@NTRegistryDeleteKey
Deletes the SUBKEY named TEXT TEXTSUBKEYNAME2 under the key path TEXT TEXTKEYPATH1 together with all values contained in it. Return value: On success TRUE, otherwise @ERROR.
@NTRegistryDeleteValue
Deletes the value named TEXT TEXTVALUENAME2 under the key path TEXT TEXTKEYPATH1. Return value: On success TRUE, otherwise @ERROR.
@NTRegistryGetValue
Retrieves the content of the value named TEXT TEXTVALUENAME2, under the key path TEXT TEXTKEYPATH1 and returns it in RETVALUE3 returned. The data type of RETVALUE3 depends on the data type of the registry value. The foll …
@NTRegistryScanSubKeys
Retrieves the TEXT TEXTKEYPATH1 subkeys located under the key path and returns them as HUGETEXTLIST returned. Return value: On success HUGETEXTLIST, otherwise @ERROR.
@NTRegistryScanValues
Retrieves the TEXT TEXTKEYPATH1 values located under the key path and returns their names as HUGETEXTLIST returned. Return value: On success HUGETEXTLIST, otherwise @ERROR.
@NTRegistrySetValue
Sets the content of the value named TEXT TEXTVALUENAME2, under the key path TEXT TEXTKEYPATH1, to the content of the variable VALUE3. The following data types are supported (for VALUE3): TEXT TEXTLIST NUMBER (set as DWOR …
@OpenQueue
Opens the message queue named TEXT TEXTQUEUENAME. On success, a queue handle is returned; otherwise @ERROR.
@Password
Generates from TEXT TEXTPASSWORD1 a hash, which is returned as TEXT . In case of an error, @Password @Error is returned. FN FNHASHTYPE2: 1 returns a hash like @Password in Notes. (Version compatible with Notes version >= …
@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 …
@ReleaseMutexSemaphore
Releases the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE . On success, @True is returned; otherwise @ERROR. A mutex semaphore can be owned (requested) by only one task at a time. (This is u …
@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 …
@RequestMutexSemaphore
Requests and, on success, locks the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE. On success, @True is returned; otherwise @ERROR. If FN FNTIMEOUT is specified, waiting for the mutex semapho …