Engine Help: Function
Filtered overview of the Engine Help documentation.
@SetOSComPortLineInfo
Sets the port info for an OSCOMPORT (device). FNDATA1: Data bits: 7 or 8 FNPARITY1: Parity bits (unclear) 0 = 1 bit, 2 = 2 bits ??? FNSTOP1: Stop bits (unclear) 0 = 1 bit, 2 = 2 bits ??? FNTBREAK1 (TransBreak): Unclear ? …
@SetOSComPortSpeed
Ret:=@SetOSComPortSpeed(com1;2400); Note : This text was machine-translated and may contain inaccuracies.
@SetPosAttachedFile
Sets the position in the file attachment identified by OBJECTFILEHANDLE OBJECTFILEHANDLE1 to the values specified in FN POSITION2 specified position (in bytes), taking into account mode TEXT MODE3. The new position is re …
@SetPosBuffer
Sets the position in the BINBUFFER with BUFFERHANDLE BUFFERHANDLE1 to the values specified in FN POSITION2 (in bytes), taking into account mode TEXT MODE3. MODE3: S=Calculated from the start of the BINBUFFER C=Current po …
@SetPosOSFile
Sets the position in the OSFILE with FILEHANDLE FILEHANDLE1 to the values specified in FN POSITION2 (in bytes), taking into account mode TEXT MODE3. MODE3: S=Calculated from the start of the OSFILE C=Current position + P …
@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 …
@SetSchedListEntry
Sets the data for a specific entry FN POSITION2 of the SCHEDLIST SCHEDLIST1. In UID UID3 receives the UID of the document to which this entry refers. In TDLIST TDLRANGE4 specifies the time range of this entry. 1st ele …
@SetTaskTimeout
Enables task timeout monitoring for the task that calls @SetTaskTimeout. FN FN1 specifies the time, in seconds, that the task may still take after the @Function call until the next call to @SetTaskTimeout oder @ClearTask …
@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 …
@Shell
Executes the OS/2 shell commands in TEXT COMMAND1 and returns the return status.
@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 …
@Sin
Calculates the sine of FN/FNLIST FN1/FNLIST1.
@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.
@Sqrt
Calculates the square root of FN/FNLIST FN1/FNLIST1.
@StartOSComPortTransmit
Starts buffering and transmission (with handshake, etc.) for the COM port identified by OSCOMHANDLE OSCOMHANDLE1.
@StopOSComPortTransmit
Stops buffering and transmission (with handshake, etc.) for the COM port identified by OSCOMHANDLE OSCOMHANDLE1.
@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 …
@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 …