Engine Help Category: Database
Filtered overview of the Engine Help documentation.
@BuildNamedDocKeyLists
This @Function creates two corresponding lists (HUGETEXT RETHTL and IDLIST RETIDL). In the list HUGETEXT RETHTL the contents of the fields are returned sorted alphabetically, from the documents specified by the selection …
@CheckHandle
Checks whether VIEWHANDLE/NOTEHANDLE/DBHANDLE/FILEHANDLE... VIEWHANDLE1/NOTEHANDLE1/DBHANDLE1/FILEHANDLE1... is an open handle. If yes, TRUE returned, otherwise FALSE. FILEHANDLE can only be checked as of version 1.93.
@ClearFolder
This @Function removes all documents in the DB with the DBHANDLE DBHANDLE1, from the folder with the VIEWHANDLE VIEWHANDLEFOLDER2. (The documents are only removed from the folder and not deleted from the DB.) ReturnWert: …
@CloseAgent
Closes the agent (filter) with the AGENTHANDLE AGENTHANDLE1 and returns the closed AGENTHANDLE back.
@CloseAttachedFile
Closes the file attachment with the OBJECTFILEHANDLE OBJECTFILEHANDLE1 and returns the closed OBJECTFILEHANDLE back.
@CloseDB
Closes a previously opened database with the DBHANDLE DBHANDLE1 and returns the closed DBHANDLE1 As of version 1.93, TEXT OPTIONS2 more specific or additional behavior can be specified. OPTIONS2: S: Also closes the sessi …
@CloseFtSearch
Closes a previously opened full-text search with the FTSEARCHHANDLE FTSEARCHHANDLE1 and returns the closed FTSEARCHHANDLE1.
@CompactDB
The DB with the NOTESPATH NOTESPATH1 is compacted. FNOPTIONS: BIT DEC HEX BEDEUTUNG 01 00001 0001 02 00002 0002 03 00004 0004 04 00008 0008 05 00016 0010 06 00032 0020 07 00 …
@CopyACL
Copies the ACL of the database with the DBHANDLE DBHANDLE1 to the database with the DBHANDLE DBHANDLE2. If the @function was executed successfully, the @function result has the data type PV. The executing server must hav …
@CopyDB
Copies the database with the DBHANDLE DBHANDLE4 to a database with the NOTESPATH NOTHESPATH1 and the DBCLASS DBCLASS2 and returns a DBHANDLE to it. The documents matching the specification in NOTECLASSES NOTECLASSES6 mat …
@CopyFolder
This @function copies, in the DB with the DBHANDLE DBHANDLE1, the folder with the VIEWHANDLE VIEWHANDLEFOLDER2 as a folder named TEXT NEWFOLDERNAME3. (All documents, subfolders, and the design are copied.) Returnvalue: I …
@CopyNote
Copies the document with the NOTEHANDLE NOTEHANDLE2 to the database with the DBHANDLE DBHANDLE1 and returns the NOTEHANDLE to this new document. NOTEHANDLE3 is the NOTEHANDLE of the new document.
@CopyTemplateACL
Copies the template ACL of the database with the DBHANDLE DBHANDLE1 as the ACL into the database with the DBHANDLE DBHANDLE2. Template ACL entries are specified in the ACL in square brackets. This @function converts thes …
@CreateDB
Creates a new completely empty database of DBCLASS DBCLASS2 under the NOTESPATH NOTESPATH1 and returns a DBHANDLE to it. With FN OVERWRITE3 can be used to specify whether an existing database with the same name should be …
@CreateDBActivity
Starts logging the user activity of the database with the DBHANDLE DBHANDLE1. If NUMBER 1 is returned if the operation was successful (or user activity already exists); otherwise ERROR.
@CreateNote
Creates a new document in the database with the DBHANDLE DBHANDLE1 for the NOTEHANDLE NOTEHANDLE2 and returns the NOTEHANDLE to it.
@CreateObjectStore
Creates a new Notes object store database with the NOTESPATH NOTESPATH1. With the parameter FN BOOLOVERWRITE2 specifies whether an already existing Notes object store database with this NOTESPATH NOTESPATH1 should be ove …
@DeleteDB
Deletes a database with the NOTESPATH NOTESPATH1. If the returned value is NUMBER 1, the operation was successful, otherwise ERROR.
@DeleteDBActivity
Deletes the user activity of the database with the DBHANDLE DBHANDLE1. If the returned value is NUMBER 1, the operation was successful, otherwise ERROR.
@DeleteDBARConnection
Deletes a specific Advanced Replication Settings connection between the target server TEXT DESTINATIONSERVER and the source server TEXT SOURCESERVER. The entry for Anyserver (wildcard "-") as source server cannot are del …
@DeleteDBReplicaHistory
Deletes the replication history of the database with the DBHANDLE DBHANDLE1. If the returned value is NUMBER 1, the operation was successful, otherwise ERROR.
@DeleteDifferenceByFormula
Deletes documents in the database with the DBHANDLE TODBHANDLE2 which are not present in the database with the DBHANDLE FROMDBHANDLE1. It be only documents taken into account are, which have the NOTECLASS specified with …
@DeleteNote
Deletes a document with the NOTEHANDLE NOTEHANDLE1 in of the database with the DBHANDLE DBHANDLE2. The document must have been opened beforehand. Deleting it automatically closes it. In FN FNUPDFLAGS3 can Optionen specif …
@DeleteNoteByID
Deletes the document or documents with the NOTEID NOTEID2, or with the NOTEIDLIST NOTEID2, in the database with the DBHANDLE DBHANDLE1. If the operation was completed successfully, the @Function result is the number of d …
@DeleteNoteByPosition
Deletes a document in the database with DBHANDLE DBHANDLE1 in the view with VIEWHANDLE VIEWHANDLE2 at position VIEWPOSITION/VIEWPOS VIEWPOSITION3. The document must not be opened. If the operation was executed successful …
@FolderAddDoc
This @Function adds, in the DB with the DBHANDLE DBHANDLE1, the documents,whose NOTEID's in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 can be specified, in the Folder with the VIEWHANDLE VIEWHANDLEFOLDER2 a. Return value: If t …
@FolderRemoveDoc
This @Function removes, in the DB with the DBHANDLE DBHANDLE1, the documents whose NOTEIDs can be specified in FN/FNLIST/IDLIST FN3/FNLIST3/IDLIST3 from the folder with the VIEWHANDLE VIEWHANDLEFOLDER2. (The document is …
@FtSearch
@FtSearch performs the actual search defined by FTSEARCHHANDLE FTSEARCHHANDLE1. The parameter FN FNLIMIT2 can be used to limit the number of documents found. If 0 is specified here, all documents are found. The parameter …
@GetACL
Retrieves the ACL of the database with the OSPATH OSPATH1 or DBHANDLE DBHANDLE1 and returns it split into TEXTLIST USERNAMES2, NUMBERLIST USERLEVEL3, TEXTLIST USERPRIVS4 and TEXTLIST PRIVNAMES5. USERNAMES2: The ACL name …
@GetACLHistory
The ACL change history of the DB with the DBHANDLE DBHANDLE1 as TEXTLIST is returned. Example @GetACLHistory(DBHANDLE1): DBHANDLE1:=@OpenDB("TEST.NSF"); @LogReport(@GetACLHistory(DBHANDLE1)); DBHANDLE1:=@CloseDB(DBHANDLE …
@GetACLMaxINetAccess
Returns the maximum Internet access of the DB with the DBHANDLE DBHANDLE1. LEVEL: 6=Manager 5=Developer 4=Editor 3=Author 2=Depositor 1=Reader 0=No Access Return: FN -> Success @Error -> Error @ERROR ACL NOT …
@GetApiLogDocInfo
This @Function returns the DBHANDLE DBHANDLE1 and the NOTEHANDLE NOTEHANDLE2 of the current APILOG document. The return value of the @Function is always TRUE. If the values are not available, the data type DBHANDLE1 and …
@GetDBActivity
Retrieves the user-activity log of the database with DBHANDLE1. The @Function result is 1 if there is no error, or @ERROR. The last four arguments of the @Function are return parameters: In RETTDLIST2 the times are retur …
@GetDBARConnection
For the DB with the DBHANDLE DBHANDLE1 returns the settings of the Advanced Replication Connection from the source server TEXT SOURCESERVER to the destination server TEXT DESTINATIONSERVER if a definition exists for this …
@GetDBARConnections
The list is returned in TEXTLIST TLRETDESTINATIONSERVERS the list of destination servers is returned for which Advanced Replication Settings are defined in the DB with the DBHANDLE DBHANDLE1. Optionally, the parameter TE …
@GetDBCurrentAccess
For the DB with the DBHANDLE DBHANDLE1 the current access level at the time of the call and, optionally, the currently effective flags (NUMBER NRETFLAGS) are returned. In case of an error, @Error is returned. USERLEVELS: …
@GetDBDocumentCount
The number of data documents in the DB with the DBHANDLE DBHANDLE1 is returned. Optionally, the number of deleted documents FLOAT FLOATDELETEDCOUNT and the number of design documents FLOAT FLOATDESIGNCOUNT can be queried …
@GetDBID
The ID of the DB with the DBHANDLE DBHANDLE1 is returned. The ID is a TD value that indicates when the DB was created.
@GetDBLaunchOptions
Returns the launch DB options of the DB with the DBHANDLE DBHANDLE1 as a bit vector (FN). In TEXTLIST TEXTLIST1 the names of the navigators or the view are returned. In RID RID1 the RID of the DB to which the doclink poi …
@GetDBModified
Returns when the database with the DBHANDLE DBHANDLE1 was last modified. The return value (TD) contains the last modification of a data document and TD TD1 contains the last modification of a non-data document.
@GetDBObjectStoreID
Returns the replica ID (RID/DBID) of the Notes object store database associated with the database with the DBHANDLE DBHANDLE is returned. In case of an error, @ERROR is returned.
@GetDBOptions
Returns the DB options of the DB with the DBHANDLE DBHANDLE1 as a bit vector (FN). In FN FNEXTOPTIONS the extended options of the DB are returned. FNEXTOPTIONS: BIT DEC HEX MEANING if set 01 000001 00001 Allo …
@GetDBPath
Returns the OSPATH and the NOTESPATH of the database with the DBHANDLE DBHANDLE1 in a TEXTLIST. If the database was opened by specifying a server (for example "TEST_SERVER!!TEST.NSF"), both elements are identical (that i …
@GetDBQuota
Returns the DB quota of the DB with the DBHANDLE DBHANDLE1 as FLOATLIST with 4 elements. Element No. Meaning 1 Maxium size in kB of the database 2 Actual size in kB of the database 3 Quota in kB of the database 4 …
@GetDBReplicaHistory
Retrieves the replication history of the database with the DBHANDLE DBHANDLE1. A TEXTLIST with the names of the servers/users is returned directly. In RETTD1 a TDLIST with the respective last replication date, correspond …
@GetDBReplicaInfo
Retrieves the replication information: replica ID TD REPLICAID2, replication flags NUMBER FLAGS3, replication deletion interval NUMBER CUTOFFINTERVAL4 and replication deletion time TD CUTOFFTD5 of the database with the D …
@GetDBSpaceUsage
The size of the DB with the DBHANDLE DBHANDLE1 is returned in bytes, rounded up to full MB. Optionally, the number of used bytes (FLOAT FLOATALLOC) or free bytes (FLOAT FLOATFREE) and the percentage usage (FLOAT FLOATUSE …
@GetDBTitle
Returns the database title and the database categories of the database with the DBHANDLE DBHANDLE1. The return value is of type TEXTLIST where the first element contains the title and one additional element follows for e …
@GetDBVersion
Returns the FN major version (ODS version) of the database with the DBHANDLE DBHANDLE1. In the optional parameter FNRETMINVERSION the minor version of the database is returned.
@GetFolderCount
This @function returns the number of documents, that are located in the DB, with the DBHANDLE DBHANDLE1 in the folthe with the VIEWHANDLE VIEWHANDLEFOLDER2, are located. Return value: If the @function was executed succes …