Engine Help: Function
Filtered overview of the Engine Help documentation.
@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 …
@Unavailable
Deletes a variable in a document or a VARGROUP by returning the value UV Unavailable when it is used as the right-hand value of an assignment.
@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 …
@UpdateNote
Updates the document identified by NOTEHANDLE NOTEHANDLE1 and returns the NOTEHANDLE. FN MODE2 can be used to specify more detailed behavior. MODE2: 0 = Do not save changes. 1 = Save changes. 2 = Save changes without cha …
@UpdateView
Updates the view identified by VIEWHANDLE VIEWHANDLE1 and returns VIEWHANDLE1.
@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.
@ViewPos
Returns the information for the VIEWPOS VIEWPOS . The return value of the @Function returns the number of documents found, for example by the @Function @FindDocumentsByKey. The optional parameter FNLIST FNPOSLIST returns …
@WaitNTComPortEvent
Waits for a specific event that occurs on the COM port identified by OSCOMHANDLE OSCOMHANDLE1. If FN MASK2 is not specified, the current setting applies. Otherwise, the valid event mask is set to the passed value before …
@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 …
@WriteACL
This @Function writes an in-memory copy of the ACL to the database specified by the DBHANDLE DBHANDLE. When the VSPECHACL handle is no longer required, it must be released using @ReleaseACL. This @Function does not relea …
@WriteBuffer
Writes the contents of a variable from the current position; see @GetPosBuffer/@SetPosBuffer, to the BINBUFFER identified by BUFFERHANDLE BUFFERHANDLE1. Currently, the following data types are supported for VAR2: TEXT TE …
@WriteNTComPort
Outputs the contents of a variable of type TEXT, FN, or TD to a previously opened COM port. Only for Engine under Windows!
@WriteOSComPort
Example: @WriteOSComPort(OSCOMHANDLE1;TEXT2) OSCOMHANDLE1:=@OpenOSComPort("COM1"); TEXT2:="TestText"; @WriteOSComPort(OSCOMHANDLE1;TEXT2); FILEHANDLE1:=@CloseOSComPort(OSCOMHANDLE1); Opens a COM port, writes "TestText" t …
@WriteOSFile
Writes the contents of TEXT/FN/TD TEXT2/FN2/TD2 to the OSFILE identified by FILEHANDLE FILEHANDLE1. If the operation was successful, 1 (NUMBER) is returned. The optional parameter TEXT TEXTWRITETYPE3 specifies the write …
@WriteVarOSFile
Writes the complete representation of the variable VAR, including all associated metadata, in binary form to the OSFILE identified by the FILEHANDLE FILEHANDLE1. If the operation is successful, 1 (NUMBER) is returned. A …
@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 …
@Yesterday
Returns the date of the previous day.
@ZeroOID
Returns a NULL OID. A zero OID is required in certain situations. For example, for DocLinks or to transfer document copies to other databases.
@ZeroUID
Returns a UIDLIST with one NULL element. (The UID consists entirely of zeros.) A zero UID is required in certain situations. For example, for DocLinks.
Operator -
Analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
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 !
In principle, analogous to Notes. Difference: Empty text ("") is treated as Boolean 0. Non-empty text (e.g. "X") is treated as Boolean 1. Important error note: When used together with other operators, parentheses must be …
Operator !=
In principle, analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator *
In principle, analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator /
In principle, analogous to Notes. Note : This text was machine-translated and may contain inaccuracies.
Operator &
Analogous to Notes in principal. Difference: Empty text ("") is viewed as Bool 0. Non-empty text (z.B. "X") is viewed as Bool 1.
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.
Operator |
Basically analogous to Notes. Difference: Empty text ("") is treated as Boolean 0. Non-empty text (for example "X") is treated as Boolean 1. Note : This text was machine-translated and may contain inaccuracies.