Engine Help: Function
Filtered overview of the Engine Help documentation.
@GetBufferInfo
Returns information about the BINBUFFER with the BUFFERHANDLE BUFFERHANDLE1 is returned. The buffer pointer is returned as the return value. FN RETFNUSEDSIZE: The currently used size of the buffer. FN RETFNALLOCSIZE: The …
@GetDataType
Returns the data type of the variable VAR1. Data type: Return value: TEXT A TEXTLIST AL NUMBER N NUMBERLIST NL FLOAT F FLOATLIST FL TD T TDLIST TL RT (RICHTEXT) RT ID I IDLIST IL UNIDLIST …
@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.
@GetDEFFNGlobal
Returns the names of all GLOBAL functions defined with DEFFN defined functions.
@GetDeleteCount
Returns the number of documents currently deleted by the program.
@GetDiskSpace
Returns in a FLOATLIST the used and free space of the drive with the letter TEXT OSDRIVE1: 1.Element: benutzter Platz 2.Element: freier Platz
@GetDocPrivileges
Returns a FLOATLIST of the document with the NOTEHANDLE NOTEHANDLE1 associated privileges. If the document has no privileges, the list has 0 elements.
@GetDoneCount
Returns the number of documents currently processed by the progron (IDF).
@GetEngineTasks
Returns a list (TEXTLIST) the Engine tasks active when the @function is called.
@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 …
@GetFieldFlags
Returns the Notes field flags of a varifromle. Field-Flags: 1 SIGN 2 SEAL 4 SUMMARY 16 SEALED 32 READ/WRITE-ACCESS 64 NAMES 256 PLACEHOLDER 512 PROTECTED 1024 READ-ACCESS Practical examples of combinati …
@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 …
@GetHexDump
@GetHexDump returns the content of the variable VAR as a hex dump. VAR may be of any type, except HUGE data types*. *HUGE data types (see @GetDataType): VHUGEHUGEITEM HI VHUGERTCOMPONENTS RC VHUGEHUGERT …
@GetLastNotesErrorCode
Returns the Notes error code of the last Notes function of this task as FN. (This can therefore aso be NOERROR=0.) See aso @GetNotesErrorString.
@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 …
@GetListElement
Returns the element an FN/FNLIST POSITION2/POSITIONLIST2 of FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/ID/IDLIST/HUGETEXTLIST/UNIDLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/ID1/IDLIST1/HUGETEXTLIST1/UNIDLIST1, where in the case …
@GetMailAddress
Returns the mail address or, wenn eingetragen, the mail address to forwasding to User TEXT USER1 (from the address book).
@GetMailLocation
Returns the Mail relevanten Informationen to User TEXT (from the Adressbuch). Als Return value is the MailServer (TEXT) returned. In P2 is the Mailfilename (TEXT) returned.
@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.
@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 …
@GetNoteID
Returns the NoteID (ID) of the document with the NOTEHANDLE NOTEHANDLE1. NOTE: Only documents that were opened from a database have a NoteID.
@GetNoteIDsByPosition
Gets in the view with the VIEWHANDLE VIEWHANDLE1 from the position VIEWPOSITION/VIEWPOS VIEWPOSITION2 the NoteIDs and returns them as IDLIST. In the position 10 of the VIEWPOSITION/VIEWPOS VIEWPOSITION2 is the number Not …
@GetNoteIDsFromView
The NoteID's the documents in the view to VIEWHANDLE VIEWHANDLE1 are, from of the VIEWPOSITION/VIEWPOS VIEWPOSITION2, as IDList returned. VIEWPOSITION2 is a FNLIST with 10 entries. The 1st entry contains the number of ca …
@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.
@GetNTComPortEventMask
Only for the Engine under Windows! Current event mask for the COM port with OSCOMHANDLE OSCOMHANDLE1 query and return. Return value: Bit HEX C-Symbol meaning 1 0001 EV_RXCHAR A character was received and a …
@GetNTComPortHandshake
Only for the Engine under Windows! Current handshake setting for the COM port with OSCOMHANDLE OSCOMHANDLE1 query and return. FN RTS2: (Ready-to-send) Wert C-Symbol meaning 0 RTS_CONTROL_DISABLE Disfroml …
@GetNTComPortInQueCount
Only for the Engine under Windows! Returns the number the bytes that are available at the time of the call to retrieval with @ReadNTComPort were available.
@GetNTComPortModemStatus
Only for the Engine under Windows! Current status of a modem on COM port with OSCOMHANDLE OSCOMHANDLE1 query and return. Return value: Bit HEX C-Symbol meaning 5 0010 MS_CTS_ON The CTS-line is HIGH 6 …
@GetNTComPortOutQueCount
Only for the Engine under Windows! Returns the number the bytes that are available at the time of the call noch im send buffer to transmission are available.
@GetNTComPortProperties
Only for the Engine under Windows! Current setting options for the COM port with OSCOMHANDLE OSCOMHANDLE1 query and return. All returned values sind bitwise encoded and according to options set. CAPA2: (Provider capfromi …
@GetNTComPortSettings
Only for the Engine under Windows! Current settings for the COM port with OSCOMHANDLE OSCOMHANDLE1 query and return. BAUD2: (Baudrate) 300 ... 128k DATA3: (number of data bits) 5 6 7 8 STOP4: (number of stop bits) 0 …