Engine Help: Function
Filtered overview of the Engine Help documentation.
@ReplicateWithFormulaWithFieldException
Deprecated! See @ReplicateWithFormulaWithFieldProtection Note : This text was machine-translated and may contain inaccuracies.
@ReplicateWithFormulaWithFieldProtection
Replicates the database referenced by DBHANDLE1 with the database referenced by DBHANDLE2. Only documents that match the Notes-compatible selection formula TEXT FORMULA3 are replicated. FNLIST4 contains the replication r …
@ReplicateWithServer
The databases of the local Notes server are replicated with the remote Notes server TEXT SERVERNAME2 over the port TEXT PORTNAME1 by the Notes replicator, not by the Engine replicator. Using FN OPTIONS3, options can be s …
@RequestClass
Requests the class or classes with the name(s) TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1. Return value: @Error -> An error occurred. TRUE -> All requested classes were obtained. FALSE -> At least one of the r …
@RequestMutexSemaphore
Requests and, on success, locks the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE. On success, @True is returned; otherwise @ERROR. If FN FNTIMEOUT is specified, waiting for the mutex semapho …
@ResetVStack
Resets all variables on the VStack with the name TEXT NAME1 to the value in VAR1. If the @Function is called without the second parameter, the variables are set to the value/data type PV. Sub-VStacks located on the VStac …
@ResolveUserGroups
This @Function determines the complete name list for a specified Domino user, including all direct and indirect group memberships. The function returns a TEXTLIST whose first element is the resolved user name. The subseq …
@Reverse
Reverses the order of the characters in TEXT TEXT1 or in each element of TEXTLIST TEXTLIST1.
@RFC822Add
Adds another segment to an RFC822 field. VHUGERFC822 RFC822: The RFC822 field to which the segment is to be added. An empty VHUGERFC822 RFC822 can be created using @HugeRFC822. FN FLAGS: The flags for this segment, or th …
@RFC822Get
Returns information about an RFC822 segment of VHUGERFC822 RFC822. FN FNSEGMENTNR: Segment number of the segment whose information is requested. Counting starts at 1. Return FN RETFLAGS: This parameter returns the flags …
@Right
Returns the right part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selection can be based on FN COUNT2 characters or on the text to the right of TEXT TEXT2. The search for TEXT2 is performed from left to right.
@RightBack
Returns the right part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selection can include all characters except FN COUNT2 remaining characters, or the text to the right of TEXT TEXT2. The search for TEXT2 is performed from righ …
@RTAddButton
Appends a button labeled TEXT TEXT1 and containing the CNFORMULA CNFORMULA4 to the RichText field RT RT5. FNLIST STYLE2: 1. StyleDefinitionNumber 2. Font 3. Size 4. options 5. Color 1. StyleDefinitionNumber: Re …
@RTAddDocLink
Inserts a document link (DocLink) into the RichText field RT RTFIELD4. The link points to the document identified by NOTEHANDLE NOTEHANDLE3 in the database identified by DBHANDLE DBHANDLE1 and from the view identified by …
@RTAddFileIcon
Appends a file icon in OS/2 style to the RichText field RT RT4. TEXT1: Name of the file attachment used for display and for reference within the Notes document. This name must be unique. TEXT2: Original name of the file …
@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.
