Engine Help: S
Filtered overview of the Engine Help documentation.
@SaveMain
Only within IDF: Negates the general setting for saving the MAIN documentes. See IDF document SECTION SYSTEM.
@ScanDB
Searches for all documents in the database with DBHANDLE DBHANDLE1 that match the selection formula TEXT FORMULA2 and were modified in this DB before the time TD SINCE3 and are contained in NOTECLASSES NOTECLASSES4 . If …
@ScanDBDeleted
Searches for all deleted documents in the database with DBHANDLE DBHANDLE1 and the NOTECLASS(EN) NOTECLASSES2. The optional parameter TD SINCE4 restricts the search to documents that have been deleted since the specified …
@ScanOSDirectory
Scans a directory for the files it contains. In TEXT OSMATCHPATH specifies the OS path with the search criteria (wildcards...). In TEXT OPTIONS1 can be used to specify the file attributes that the files to be searched ma …
@ScanVStack
Returns all variables on the VStack with the name TEXT NAME1 als TEXTLIST as a TEXTLIST. variables of the data types PV und UA are not taken into account. If only "" is specified for NAME1 , the variables from _PRCVSTACK …
@SearchKeyList
This @Funktion searches a sorted HUGETEXTLIST HTL1 for TEXT TEXT2; it must be fully contained as an element of HUGETEXTLIST HTL1 and, if present, returns the position of TEXT TEXT2 in the HUGETEXTLIST HTL1 in FN RETPOS3 …
@Second
Returns the seconds of TD/TDLIST TD1/TDLIST1 value. If the @Function is called with the parameter TEXTOPTIONS , it determines the return type. F=like without specifying TEXTOPTIONS (return data type = FLOAT/FLOATLIST) A= …
@ServerPing
This @Funktion can be used to check the reachability or availability of the server named TEXT TEXT1 . Return value: If the server responds, the workload index (FN) of the server is returned; otherwise an @ERROR-Wert.
@SetACL
Writes the ACL described by PARAMETERS2-5 to the database identified by DBHANDLE DBHANDLE. This ACL must always contain at least one entry with ACL-LEVEL=6. The APIEngine server that writes the ACL must have Manager acce …
@SetACLMaxINetAccess
Sets the Maximum Internet Access level of the database identified by DBHANDLE DBHANDLE1 to the level FN FNLEVEL2. FNLEVEL2: 6=Manager 5=Developer 4=Editor 3=Author 2=Depositor 1=Reader 0=No Access Return: FN -> S …
@SetAttachmentFlags
Sets the flags FN FNFLAGS3 for the attachment at position FN FNATTACHMENTNR2 in the document identified by NOTEHANDLE NOTEHANDLE1. The positions are the same as those returned by @AttachmentInfo. On success, the function …
@SetAttachmentHostType
Sets the HostType FN FNHOSTTYPE3 for the attachment at position FN FNATTACHMENTNR2 in the document identified by NOTEHANDLE NOTEHANDLE1. The positions are the same as those returned by @AttachmentInfo. On success, the fu …
@SetDBARConnection
Sets the Advanced Replication Connection settings in the database identified by DBHANDLE DBHANDLE1 from the source server TEXT SOURCESERVER to the destination server TEXT DESTINATIONSERVER. If a definition for this desti …
@SetDBLaunchOptions
Sets the database launch options of the database identified by DBHANDLE DBHANDLE1. FN FNOPTIONS specifies the database launch options of the database. TEXTLIST TEXTLIST1 specifies the names of the navigators or the view. …
@SetDBObjectStoreID
This @Function associates the database with DBHANDLE DBHANDLE1 with the Notes object store database with RID RID2. Return value: On success, TRUE, otherwise @ERROR.
@SetDBOptions
Sets the database options specified in FN FN2 in the database identified by DBHANDLE DBHANDLE1. If FN FNEXTOPTIONS is specified, the extended database options are also set; otherwise they remain unchanged. On success, FN …
@SetDBQuota
Sets the database quota of the database identified by DBHANDLE DBHANDLE1 to the values specified in FNLIST FNLISTQUOTA2. Element No. Meaning 1 Maximum size of the database in kB 2 Actual size of the database in kB …
@SetDBReplicaInfo
Sets in the database identified by DBHANDLE DBHANDLE1 the replication information: replica ID TD REPLICAID2, replication flags FN FLAGS3, replication purge interval FN CUTOFFINTERVAL4 and replication cutoff time TD CUTOF …
@SetDBTitle
Sets the title and categories of the database identified by DBHANDLE DBHANDLE1. With TEXT TEXT2 it is interpreted as the title and the categories are deleted; with TEXTLIST TEXTLIST2 the first element of the list is inte …
@SetDocPrivileges
Sets in the document identified by NOTEHANDLE NOTEHANDLE1 the privileges specified in FLOATLIST PRIVILEGES2.
@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
Only for Engine under Windows! 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 …
@SetNTComPortHandshake
Only for Engine under Windows! 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) Val …
@SetNTComPortSettings
Only for Engine under Windows! 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 use …
@SetNTComPortTimeouts
Only for Engine under Windows! 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 …
@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.