Engine Help Category: Note
Filtered overview of the Engine Help documentation.
@Accessed
Returns the time of the last access to the document with the NOTEHANDLE NOTEHANDLE1 back.
@AttachmentInfo
Returns the requested information (OPTIONS2) about the attached files of the document (NOTEHANDLE1) back. A list is returned whose data type corresponds to the requested information. The positions are always the same, i. …
@AttachmentLength
Returns the sizes of the file attachments attached to the document with the NOTEHANDLE NOTEHANDLE1 as FLOATLIST back. The order of the elements in the returned list is analogous to the order of the list returned by @Atta …
@AttachmentNames
Returns the names of the file attachments attached to the document with the NOTEHANDLE NOTEHANDLE1 as TEXTLIST back. The order of the elements in the returned list is analogous to the order of the list returned by @Attac …
@AttachmentRename
All attachment fields ($File) of the document with the NOTEHANDLE NOTEHANDLE1, for the names specified in TEXT/TEXTLIST TEXT1/TEXTLIST1specified names are searched and, if there is a match (case-insensitive), the corresp …
@Attachments
Returns the number of file attachments attached to the document with the NOTEHANDLE NOTEHANDLE1.
@AttachOSFileToNote
Attaches to the document with the NOTEHANDLE NOTEHANDLE1 the files whose OSPATH(s) are specified in the TEXT/TEXTLISTE TEXT1/TEXTLIST1. If a TEXT/TEXTLIST TEXT2/TEXTLIST2 is specified, the file attachments are named afte …
@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.
@CloseAttachedFile
Closes the file attachment with the OBJECTFILEHANDLE OBJECTFILEHANDLE1 and returns the closed OBJECTFILEHANDLE back.
@CloseNote
Closes the document with the NOTEHANDLE NOTEHANDLE1 and returns the closed NOTEHANDLE. With FN MODE2 can be used to specify more detailed behavior. MODE2: 0 = Do not save changes. 1 = Save changes. 2 = Save changes witho …
@CopyAttachment
Copies attachments from the opened document with the NOTEHANDLE NOTEHANDLE3 of the database DBHANDLE DBHANDLE1 to the likewise opened document NOTEHANDLE NOTEHANDLE4 of the database DBHANDLE DBHANDLE2, without considerin …
@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 …
@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.
@CreateAttachmentFromBuffer
Creates from the content of the BINBUFFER BINBUFFER an attachment with the (internal) name TEXT TEXTNAME in the document with the NOTEHANDLE NOTEHANDLE. FN FNOPTIONS: 0 None 1 Overwrite a possibly existing attachment …
@Created
Returns the time/date value (TD) of the creation of the document with the NOTEHANDLE NOTEHANDLE1.
@CreateNote
Creates a new document in the database with the DBHANDLE DBHANDLE1 for the NOTEHANDLE NOTEHANDLE2 and returns the NOTEHANDLE to it.
@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 …
@DetachOSFileFromNote
Deletes one or more files from the document with NOTEHANDLE NOTEHANDLE1 whose file name(s) are specified in TEXT/TEXTLIST TEXT1/TEXTLIST1 or whose list position numbers (@AttachmentInfo) are specified in FN/FNLIST FN1/FN …
@DocLength
Returns the size of the document with the NOTEHANDLE NOTEHANDLE1 (object size of the document without attachments). If @DocLength is used in the second format, the lengths of the contents of the fields (and the attachmen …
@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 …
@ExtractOSFileFromNote
Copies one or more file attachments, whose names or positions (see @AttachmentInfo) in TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 are specified, from the document with the NOTEHANDLE NOTEHANDLE1 as files to a dr …
@FindCategoryByName
Searches in the view with the VIEWHANDLE VIEWHANDLE1 the category with the name TEXT/TEXTLIST NAME2 ab the VIEWPOSITION VIEWPOSITION3 and liefert the VIEWPOSITION on success. VIEWPOSITION3 is an FNLIST with 10 entries. T …
@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 …
@GetDeleteCount
Returns the number of documents currently deleted by the program.
@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).
@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 …
@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 …
@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.
@GetNoteOID
Returns the OID of the document with the NOTEHANDLE NOTEHANDLE1.
@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 …
@GetOpenNotes
Returns the number the currently from the opened documents by this program.
@GetPosAttachedFile
Returns the current position in the file attachment with the OBJECTFILEHANDLE OBJECTFILEHANDLE1 is returned.
@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 …
@GetUpdateCount
Returns the number of documents currently modified (and also created) by the program.
@GetVar
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVarWithFieldFlags
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVStackPath2GFun
Returns the prefix for the access path of a variable stored within the thread copy of a global function. This could be used, for example, to assign default values for local parameters. However, this function should be av …
@HttpExtractFields
The HTTP POST fields in TEXT TEXT1 are stored as Engine variables on the VStack TEXT VSTACKPATH2 stored. On success, TRUE returned, otherwise @ERROR.
@MimePartAdd
A new MIMEPART segment is appended to HUGEMIMEPART MIMEPART1; the extended MIMEPART field is returned again. FN FNFLAGS2 Flag Hex Dec Kommentar MIME_PART_HAS_BOUNDARY 0001 00001 MIME_PART_HAS_HEADERS 0002 …
@MimePartGet
Returns information about a MIMEPART segment of HUGEMIMEPART MIMEPART1. FN FNSEGMENTNR2 Return FN FNFLAGS3 Flag Hex Dec Kommentar MIME_PART_HAS_BOUNDARY 0001 00001 MIME_PART_HAS_HEADERS 0002 00002 MIM …
@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.