Engine Help Category: NotesSystem
Filtered overview of the Engine Help documentation.
@Accessed
Returns the time of the last access to the document with the NOTEHANDLE NOTEHANDLE1 back.
@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.
@CloseAgent
Closes the agent (filter) with the AGENTHANDLE AGENTHANDLE1 and returns the closed AGENTHANDLE back.
@CompileFormula
Compiles TEXT1 a Notes formula text into the Notes formula compilation (CNFORMULA) and returns it. TEXT2 is required for column formulas and must contain the column item name. Example @CompileFormula(TEXT1): CNF:=@Compil …
@Created
Returns the time/date value (TD) of the creation of the document with the NOTEHANDLE NOTEHANDLE1.
@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 …
@DecompileFormula
Decompiles the binary Notes formula (CNFORMULA) CNFORMULA1 into the Notes formula text. FN2 specifies whether this is a view selection formula (=1) or not (=0). With the syntax using one parameter, it is assumed that thi …
@DeleteEnvironment
Deletes the environment variable TEXT TEXT1 physically from NOTES.INI. Returnvalue: 1 = variable could are deleted. 0 = variable not present. @Errro... = An error occurred; the variable was not deleted.
@Environment
Returns the value of the environment variable TEXT/TEXTLIST TEXT1/TEXTLIST1.
@ExecuteAgent
This @Function executes the agent with the AGENTHANDLE AGENTHANDLE1 either against all documents (without the parameter NOTEHANDLE NOTEHANDLE3) of the DB in which the agent is located, or against a single document, with …
@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 …
@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 …
@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: …
@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.
@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 …
@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 …
@GetDocPrivileges
Returns a FLOATLIST of the document with the NOTEHANDLE NOTEHANDLE1 associated privileges. If the document has no privileges, the list has 0 elements.
@GetFieldComponents
Returns the components of a VSPECDNFIELD DNFIELD1 variable, that is, a field in a form. The parameters PARAMETER2, PARAMETER3, PARAMETER4 and PARAMETER5 are reserved, TEXTLIST KEYWORDS6 contains the keyword list if prese …
@GetNoteClass
Returns the NOTECLASS (see NOTECLASSES) of the document with the NOTEHANDLE NOTEHANDLE1. FN NOTECLASS: DEC BIT meaning 00000 XX No Notes no documents 00001 01 Documents data documents 00002 02 Policy- …
@GetNoteDB
Gets the DBHANDLE DBHANDLE1 from the document with the NOTEHANDLE NOTEHANDLE1. Returned is of the DBHANDLE1 of the document or ein ERROR.
@GetNoteID
Returns the NoteID (ID) of the document with the NOTEHANDLE NOTEHANDLE1. NOTE: Only documents that were opened from a database have a NoteID.
@GetNoteOID
Returns the OID of the document with the NOTEHANDLE NOTEHANDLE1.
@GetNotesErrorString
Returns for einem Notes-Error-Status-Code (FN1) the corresponding error message text.
@GetNoteUID
Returns the UID of the document with the NOTEHANDLE NOTEHANDLE1.
@GetOIDComponents
Returns the components of the OID OID in TD RETTDDBID, TD RETTDNOTE, TD RETTDINSTANCETD and FLOAT RETFLOATINSTANCENUMBER. TD RETTDDBID is the database ID of the database in which the document was created. TD RETTDNOTE is …
@GetOSPath
Returns the physical/local path (OSPATH) for the relative NOTESPATH/NOTESPATHLIST NOTESPATH1/NOTESPATHLIST1. Directory and database links are taken into account. If a NOTESPATHLIST is passed as the input parameter, error …
@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 …
@Modified
Returns the time of the last modification of the document with the NOTEHANDLE NOTEHANDLE1.
@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 …
@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 …
@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 …
@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 …
@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 …