Engine Help Category: Database
Filtered overview of the Engine Help documentation.
@GetLinkListProperties
Returns the properties of the document link at the position FN POSITION2 from the VSPECLINKLIST DOCLINKLIST1. TD RETTDRID3 is the replica ID of the DB on the documents-Link verweist. (Steht hier @AnyAllDay verweist er in …
@GetNoteFieldByID
Opens the documents in the database with the DBHANDLE DBHANDLE1 and the FLOATLIST/IDLIST FNIDLIST2 and returns a TEXTLIST with the contents of the TEXT field with the names TEXT TEXTFIELDNAME3. Via the optional Parameter …
@GetOpenDBs
Returns the number the currently from the Programm openedn databaseen.
@GetPosAttachedFile
Returns the current position in the file attachment with the OBJECTFILEHANDLE OBJECTFILEHANDLE1 is returned.
@GetProfileField
Returns the contents of the profile field named TEXT TEXTFIELDNAME, for the user named TEXT TEXTUSERNAME (which may also be ""), taking into account the Profile-Form with the name TEXT TEXTPROFILEFORMNAME from the databa …
@GetRemoteDBPathByRID
On the server with the server name TEXT TEXTSERVERNAME the first DB with the replica ID RID DBRID is searched for and the Notes path (TEXT) to it is returned. The found DB can be opened with this Notes path. If no matchi …
@GetSchedListEntry
Returns the data for a specific entry FN POSITION2 of the SCHEDLIST SCHEDLIST1 is returned. In UID UID3 the UID of the document to which this entry refers is returned. In TDLIST TDLRANGE4 the time span of this entry is r …
@GetStartDocInfo
This @Function returns the DBHANDLE and the NOTEID of the document that caused this program to start. In DBHANDLE1 is the DBHANDLE of the database containing the triggering document is returned. In ID2 the NOTEID of the …
@MainDatabase
Without parameters, @MainDatabase the DBHANDLE for the current main database (AEF DATABASE Statement). With parameters, @MainDatabase works like @OpenDB, but the opened database becomes the new main database. The previou …
@MoveFolder
This @Function moves the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2, under the folder mit the VIEWHANDLE VIEWHANDLEPARENTFOLDER3. The folders must be of the same type (shared/privat …
@NewOID
Returns a OID for a new document in a database with the DBHANDLE DBHANDLE1.
@OpenAgent
Opens in the database with the DBHANDLE DBHANDLE1 the agent/filter named TEXT TITLE2. This @Function is available only as of Notes version 4.5. Return value: If the @Function is executed successfully, an AGENTHANDLE is r …
@OpenAttachedFile
Opens the attached file with attachment number FN FNATTACHMENTNUMBER2 or with the internal (unique) attachment name TEXT TEXTATTACHMENTNAME2 und outputs einen OBJECTFILEHANDLE for it. TEXT MODE3 can be used to specify th …
@OpenDB
Opens a database with the NOTESPATH NOTESPATH1 and liefert einen DBHANDLE returned. As of version 1.93, TEXT OPTIONS2 can be used to specify more detailed behavior. OPTIONS2: L=Locked (no further opening from another loc …
@OpenDesignNote
Opens the first document in the database with the DBHANDLE DBHANDLE1, that matches the NOTECLASSES NOTECLASSES3 matches and has the TEXT TITLE2 and has the specified title, and returns the NOTEHANDLE NOTEHANDLE4 returned …
@OpenFtSearch
Opens in the database with the DBHANDLE DBHANDLE1 a full-text search with the search string TEXT TEXTQUERY2 and the options FN FNOPTIONS3. The parameter VIEWHANDLE VIEWHANDLESEARCHVIEW4 is reserved. This @Function is ava …
@OpenNoteByID
Opens the document in the database with the DBHANDLE DBHANDLE1 and the ID NOTEID2 and returns the NOTEHANDLE NOTEHANDLE3 returned. Options can be specified using the optional parameter FN FNOPTIONS4 can be used to specif …
@OpenNoteByPosition
Opens in the database with the DBHANDLE DBHANDLE1 in the view with the VIEWHANDLE VIEWHANDLE2 an the Position VIEWPOSITION VIEWPOSITION3 bzw. VIEWPOS VIEWPOS3 a document and outputs NOTEHANDLE NOTEHANDLE4 as the result. …
@OpenNoteByUID
Opens the document in the database with the DBHANDLE DBHANDLE1 and the UID UID2 and returns the NOTEHANDLE NOTEHANDLE3 returned. FNOPTIONS4: BIT DEC HEX Meaning if set 01 00000001 00000001 Open Summary only 0 …
@OpenProfileNote
Opens a profile document in the DB with the DBHANDLE DBHANDLE1 and returns the opened NOTEHANDLE NOTEHANDLE3 for this profile document. TEXT/TEXTLIST TEXT2/TEXTLIST2: If only a TEXT is specified, this is the profile form …
@OpenView
Opens in the database with the DBHANDLE DBHANDLE1 a view/folder named TEXT NAME2 (or with the NOTEID VIEWNOTEID) and returns the VIEWHANDLE returned. Options can be specified in the parameter FN FNFLAGS3 can be used to s …
@PushAndReplace
Replicates the database with the DBHANDLE FROMDBHANDLE1 with the database with the DBHANDLE TODBHANDLE2 in the direction from FROMDBHANDLE1 to TODBHANDLE2, replicating only the documents that match the Notes-compatible s …
@PushWithFormula
Replicates the database with the DBHANDLE FROMDBHANDLE1 with the database with the DBHANDLE TODBHANDLE2 in the direction from FROMDBHANDLE1 to TODBHANDLE2, replicating only the documents that match the Notes-compatible s …
@ReadAttachedFile
Reads a record of length FN LENGTH3 from the file attachment identified by OBJECTFILEHANDLE OBJECTFILEHANDLE1. This record is returned as a variable of the data type specified by TEXT RETTYPE2. If TEXT/TEXTLIST TEXT3/TEX …
@RecalculateNote
NOTEHANDLE NOTEHANDLE1 Document on which the recalculation should be executed. NOTEHANDLE NOTEHANDLE2 Form design document containing the formulas and fields. NF FLAGS3 0 Report errors 1 Continue on errors Return TEXTLIS …
@RemoteConsole
Executes on the remote console of TEXT SERVER1 das Kommando TEXT COMMAND2 . On success, a TEXT is returned as the result; otherwise @ERROR with the error text.
@RenameFolder
This @Function assigns to the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2 the name TEXT NEWFOLDERNAME3. ReturnWert: If the @Function was executed successfully, TRUE is returned; othe …
@ReorgACLPrivileges
The empty elements of TEXTLIST PRIVNAMES2 are removed and returned in the parameter RETUSERPRIVS3 is returned. The corresponding privilege references in TEXTLIST USERPRIVS1 are adjusted and returned in the parameter RETP …
@Replicate
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2. FNLIST FNLIST3 is a list of rights where the first element specifies the replication rights in the first database and the second …
@ReplicateWithFormula
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2, replicating only the documents thas match the Notes-compatible selection formula TEXT/TEXTLIST FORMULA3. If FORMULA3 a TEXTLIST i …
@ReplicateWithFormulaWithFieldException
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2, replicating only the documents thas match the Notes-compatible selection formula TEXT FORMULA3 entsprechen. FNLIST FNLIST4 is a l …
@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 …
@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 …
@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 …
@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 …
@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 …
@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 …
@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 …
@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 …
@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 …
@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 …