Engine Help: Function
Filtered overview of the Engine Help documentation.
@SetEnvironment
Sets the environment variable TEXT TEXT1 to the value TEXT TEXT2.
@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 …
@SetLinkListProperties
Sets the properties of the document link at position FN POSITION2 in the VSPECLINKLIST DOCLINKLIST1. TD TDRID3 is the replica ID of the DB to which the document link should point. (If @AnyAllDay is specified here, the do …
@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 …
@SetLocalServerTime
Sets the Domino server time. IMPORTANT: Changing the Notes server time may cause side effects. This is especially true if the time is moved back into the past. For example, documents may disappear until the time at which …
@SetLogDocField
Sets a field named TEXT TEXT1 and with the content TEXT/TEXTLIST/FN/FNLIST/TD/TDLIST TEXT2/TEXTLIST2/FN2/FNLIST2/TD2/TDLIST2 in the current APILog document.
@SetNoteClass
Sets the NOTECLASS FN2 (see NOTECLASSES) in the document identified by NOTEHANDLE NOTEHANDLE1. Returns TRUE or an ERROR. NOTECLASS: DEC BIT Meaning 00000 XX No Notes no documents 00001 01 Documents data d …
@SetNoteDB
Associates the document identified by NOTEHANDLE NOTEHANDLE1 with the database represented by DBHANDLE DBHANDLE1. Return value: On success, TRUE is returned; otherwise @ERROR.
@SetNoteID
Sets the NOTEID to FLOAT FLOAT2 for the document represented by NOTEHANDLE NOTEHANDLE1.
@SetNoteOID
Sets in the document identified by NOTEHANDLE NOTEHANDLE the OID to OID OID2. This @Function can only be applied to newly created documents within this DB.
@SetNTComPortEventMask
Resets the current event mask for the COM port identified by OSCOMHANDLE OSCOMHANDLE1. A subsequent @WaitNTComPortEventMask can then be used to wait for the occurrence of an event. FN MASK2: Bit HEX C symbol Meanin …
@SetNTComPortHandshake
Changes the current handshake setting for the COM port identified by OSCOMHANDLE OSCOMHANDLE1. Individual values can be preserved before changing by passing -1. FN RTS2: (Ready-to-send) Value C symbol Meaning 0 …
@SetNTComPortSettings
Changes the current settings for the COM port identified by OSCOMHANDLE OSCOMHANDLE1. Individual values can be retained by passing -1 or an invalid value. @GetNTComPortProberties can be used to determine the allowed valu …
@SetNTComPortTimeouts
Resets the current timeout settings for the COM port identified by OSCOMHANDLE OSCOMHANDLE1. Except for FN RDINT2 all specified values define timeouts that start counting from the beginning of the operation, that is, wit …
@SetOSComPortInfo
FNWRTO1: Write timeout (values ?? usually 6000) Under NT, this is WriteTotalTimeoutConstant. See http://msdn2.microsoft.com/en-us/library/ms885171.aspx. FNRETO1: Read timeout (values ?? usually 6000) Under NT, this is Re …
@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 …
