Engine Help Category: Note
Filtered overview of the Engine Help documentation.
@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 …
@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 …
@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 …
@PrtVStack
Outputs the VStack with dem names NAME1 (if "" is specified, _PRCVSTACK - the local VStack of this function or context - is used). With FN OPTIONS2 the detailed behavior can be specified, and with FN SIZE3 a maximum size …
@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.
@ResetVStack
Resets all variables on the VStack with the name TEXT NAME1 to the value in VAR1. If the @Function is called without the second parameter, the variables are set to the value/data type PV. Sub-VStacks located on the VStac …
@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 …
@SaveMain
Only within IDF: Negates the general setting for saving the MAIN documentes. See IDF document SECTION SYSTEM.
@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 …
@ScanVStack
Returns all variables on the VStack with the name TEXT NAME1 als TEXTLIST as a TEXTLIST. variables of the data types PV und UA are not taken into account. If only "" is specified for NAME1 , the variables from _PRCVSTACK …
@SetAttachmentFlags
Sets the flags FN FNFLAGS3 for the attachment at position FN FNATTACHMENTNR2 in the document identified by NOTEHANDLE NOTEHANDLE1. The positions are the same as those returned by @AttachmentInfo. On success, the function …
@SetAttachmentHostType
Sets the HostType FN FNHOSTTYPE3 for the attachment at position FN FNATTACHMENTNR2 in the document identified by NOTEHANDLE NOTEHANDLE1. The positions are the same as those returned by @AttachmentInfo. On success, the fu …
@SetDocPrivileges
Sets in the document identified by NOTEHANDLE NOTEHANDLE1 the privileges specified in FLOATLIST PRIVILEGES2.
@SetFieldFlags
Sets the field flags FN2 for Notes in a variable. If a variable is not explicitly assigned flags using @SetFieldFlags, the default values are assumed. However, if flags have been assigned, those flags always apply. Field …
@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 …
@SetNoteClass
Sets the NOTECLASS FN2 (see NOTECLASSES) in the document identified by NOTEHANDLE NOTEHANDLE1. Returns TRUE or an ERROR. NOTECLASS: DEC BIT Meaning 00000 XX No Notes no documents 00001 01 Documents data d …
@SetNoteDB
Associates the document identified by NOTEHANDLE NOTEHANDLE1 with the database represented by DBHANDLE DBHANDLE1. Return value: On success, TRUE is returned; otherwise @ERROR.
@SetNoteID
Sets the NOTEID to FLOAT FLOAT2 for the document represented by NOTEHANDLE NOTEHANDLE1.
@SetNoteOID
Sets in the document identified by NOTEHANDLE NOTEHANDLE the OID to OID OID2. This @Function can only be applied to newly created documents within this DB.
@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 …
@SetVar
Sets the value of the variable(s) named TEXT/TEXTLIST NAME1 to the value VAR3. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be specified as …
@SetVarFieldFlags
Sets the Notes field flags for the field specified in TEXT NAME1 to the value FN FN1. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be specif …
@SetVarWithFieldFlags
Sets the value of the variable(s) with the name(s) TEXT/TEXTLIST NAME1 to the value VAR3. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be sp …
@TransferNoteHandle
Maps the external NOTEHANDLE NOTEHANDLE1 to NOTEHANDLE NOTEHANDLE2 and transfers it into the current context. NOTEHANDLE NOTEHANDLE2 is returned. @TransferNoteHandle is primarily intended for GLOBAL DEFFN functions in wh …
@Translate
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted as defined by FN FNCHARSETS. This is the direct invocation of the function in the Domino API. FN FNCHARSETS: OS_TRANSLATE_NATIVE_TO_LMBCS 0 /* Translate platform-specific t …
@TranslateASCIIToEBCDIC
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the EBCDIC character set.
@TranslateASCIIToISO88591
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the ISO88591 character set.
@TranslateASCIIToWinANSI
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the WinANSI character set.
@TranslateEBCDICToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the EBCDIC character set to the ASCII character set.
@TranslateISO88591ToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ISO88591 character set to the ASCII character set.
@TranslateURLEncodingToUTF8
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from URL-encoding representation to the UTF8 character set.
@TranslateUTF8ToHtmlEntities
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the UTF8 character set to HTML entities.
@TranslateUTF8ToUrlEncoding
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the UTF8 character set to URL-encoding representation. The optional parameter FN FNOPTIONS1 can be used to control the conversion: FN FNOPTIONS1: 0 A + character is convert …
@TranslateWinANSIToASCII
TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the WinANSI character set to the ASCII character set.
@Unavailable
Deletes a variable in a document or a VARGROUP by returning the value UV Unavailable when it is used as the right-hand value of an assignment.
@UpdateNote
Updates the document identified by NOTEHANDLE NOTEHANDLE1 and returns the NOTEHANDLE. FN MODE2 can be used to specify more detailed behavior. MODE2: 0 = Do not save changes. 1 = Save changes. 2 = Save changes without cha …
@ZeroOID
Returns a NULL OID. A zero OID is required in certain situations. For example, for DocLinks or to transfer document copies to other databases.
@ZeroUID
Returns a UIDLIST with one NULL element. (The UID consists entirely of zeros.) A zero UID is required in certain situations. For example, for DocLinks.