Engine Help: Function
Filtered overview of the Engine Help documentation.
@RTAddHotSpotTextDocLink
Adds a document link (DocLink) to the document in the database with DBHANDLE DBHANDLE1 from the view with VIEWHANDLE VIEWHANDLE2 and the NOTEHANDLE NOTEHANDLE3 in the rich-text field RT RTFIELD4 a. The parameter DOCLINKL …
@RTAddParagraph
Appends the RICHTEXT paragraph RT1, which is a complete RICHTEXT-portion, to the HRT (HUGERICHTEXT) variable HRT2. A RICHTEXT field consists of many individual paragraphs that describe the elements of the RICHTEXT field, …
@RTAddPictureFile
This function added to the HRT field HRT3 the content the image file with FH (FILEHANDLE) PICFILEHANDLE1. With Parameter FN FILETYPE2 the type of the image file must be specified. Return value: On success, the modified H …
@RTAddPopUpEnd
Adds a logical closing pop-up bracket to the RichText field RT3. See @RtAddPopUpStart.
@RTAddPopUpStart
Appends TEXT TEXT1 or CNFORMULA CNFORMULA1 as a pop-up with the pop-up flags FN FLAGS2 to the end of the RichText value RT RT3. This should be regarded as a logical opening bracket. Everything appended to the RichText fi …
@RTAddText
Appends the TEXT TEXT1 in the font/style NUMBERLIST STYLE2 to the end of the Richtext RT RT3. FN STYLE2: 1. StyleDefinitionNumber 2. Font 3. Size 4. options 5. Color 1. StyleDefinitionNumber: Reserved 2. Font: …
@RTAttachmentIconChange
The variable RT RT1 is searched for file icons that refer to the file attachments specified in TEXT/TEXTLIST TEXT1/TEXTLIST1. Any file icons found are renamed to the names specified in TEXT/TEXTLIST TEXT2/TEXTLIST2, corr …
@RTDocFontsAddFont
Adds a new font with the name TEXT TEXT2 and the optional font family FN FNFONTFAMILY3 to a font field HRT HRT1, whose name is usually $Fonts. Return value: A FontHandle (NUMBER) for the new font, or @ERROR in case of an …
@RTDocFontsGet
Returns the available fonts from the font field HRT HRT1, whose name is usually $Fonts. RETTEXTLIST2 returns a TEXTLIST containing the names of the fonts included. RETNUMBERLIST3 returns a NUMBERLIST containing the corre …
@RTFetchInit
Initializes paragraph-by-paragraph retrieval of the RICHTEXT variable HRT HRT1. Return value: On success, a fetch handle for the HRT field HRT1 is returned; otherwise @ERROR is returned. This fetch handle must be passed …
@RTFetchParagraph
On each call, returns one paragraph of the RICHTEXT field HRT HRT1 in RT REGRTPARAGRAPH. This paragraph is returned as plain RT, not as HUGERICHTEXT. The fetch handle RTFH must initially have been initialized by @RTFetch …
@RTFetchText
Returns the text portion of HRT HRT1 as TEXT, portion by portion. At the beginning, NUMBER RETNUMBER2 must contain 0. NUMBER RETNUMBER2 specifies the SEGMENTPOINTER. If there is more text to retrieve, @RTFetchText return …
@RTInit
This function initializes an empty RichText value. FLOATLIST MARGINLIST1 can be used to set margins, and FLOATLIST TABLIST2 can be used to set tab stops for this field. MARGINLIST1: 1. Left margin in cm 2. Right margin i …
@RTInitEmpty
This function initializes an absolutely empty RichText value (0 bytes). IMPORTANT: The field flags; see @SetFieldFlags, of the return variable are set to 0. This is necessary because RichText fields should not have the S …
@RTSigTranslate
Returns, for a RICHTEXT paragraph signal (a type of identifier for a portion of RICHTEXT) a more meaningful TEXT value. In parameter FN FNMODE the type of the RICHTEXT field must be specified. By default, normal RICHTEXT …
@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 an ACL, as defined by the specified parameters, to the database identified by the DBHANDLE DBHANDLE. This ACL must always contain at least one entry with ACL-LEVEL=6. The APIEngine server that writes the ACL must …
@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
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 …