Engine Help: Function
Filtered overview of the Engine Help documentation.
@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 …
@SumOfList
Returns the sum of FN/FNLIST FNLIST1/FN2. FN FROM2 and FN TO3 can be used to specify a range for the summation; the values from element FROM2 through element TO3 are then summed.
@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 …
@Tan
Calculates the tangent of FN/FNLIST FN1/FNLIST1.
@TaskShouldStop
Returns 1 as the @Function result if the Engine should terminate, for example because the Notes server is being shut down. This function can be used as an abort condition for very long loops or endless loops that may occ …
@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.
@Time
Composes a time-date value TD from the individual values FN YEAR1/MONTH2/DAY3/HOUR4/MINUTE5/SECOND6 and returns it. NOTE: @Time in the Engine differs slightly from the Notes-@Function @Time! The @Time(TD1) usage possible …
@Today
Returns the current date.
@Tomorrow
Returns the date of the next day.
@Trace
Turns trace mode on (1) or off (0) according to FN STATE1. This determines whether all errors (1) or only severe errors (0) are written to the log file.
@TransferNoteHandle
Maps the external NOTEHANDLE NOTEHANDLE1 to NOTEHANDLE NOTEHANDLE2 and transfers it into the current context. NOTEHANDLE NOTEHANDLE2 is returned. @TransferNoteHandle is primarily intended for GLOBAL DEFFN functions in wh …
@Translate
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted as defined by FN FNCHARSETS. This is the direct invocation of the function in the Domino API. FN FNCHARSETS: OS_TRANSLATE_NATIVE_TO_LMBCS 0 /* Translate platform-specific t …
@TranslateASCIIToEBCDIC
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the EBCDIC character set.
@TranslateASCIIToISO88591
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the ISO88591 character set.
@TranslateASCIIToWinANSI
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the WinANSI character set.
@TranslateEBCDICToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the EBCDIC character set to the ASCII character set.
@TranslateISO88591ToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ISO88591 character set to the ASCII character set.
@TranslateURLEncodingToUTF8
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from URL-encoding representation to the UTF8 character set.
@TranslateUTF8ToHtmlEntities
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the UTF8 character set to HTML entities.
@TranslateUTF8ToUrlEncoding
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the UTF8 character set to URL-encoding representation. The optional parameter FN FNOPTIONS1 can be used to control the conversion: FN FNOPTIONS1: 0 A + character is convert …
@TranslateWinANSIToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the WinANSI character set to the ASCII character set.
@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 …
@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
Only for Engine under Windows! 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 …
@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 …
@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
Only for Engine under Windows! Outputs the contents of a variable of type TEXT, FN, or TD to a previously opened COM port.
@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 …