EN 843 documents

Engine Help: Function

Filtered overview of the Engine Help documentation.

← Back to Engine Help overview

581 documents found

@NTRegistryDeleteValue

Function Version 4.60

Deletes the value named TEXT TEXTVALUENAME2 under the key path TEXT TEXTKEYPATH1. Return value: On success TRUE, otherwise @ERROR.

@NTRegistryGetValue

Function Version 4.60

Retrieves the content of the value named TEXT TEXTVALUENAME2, under the key path TEXT TEXTKEYPATH1 and returns it in RETVALUE3 returned. The data type of RETVALUE3 depends on the data type of the registry value. The foll …

@NTRegistryScanSubKeys

Function Version 4.60

Retrieves the TEXT TEXTKEYPATH1 subkeys located under the key path and returns them as HUGETEXTLIST returned. Return value: On success HUGETEXTLIST, otherwise @ERROR.

@NTRegistryScanValues

Function Version 4.60

Retrieves the TEXT TEXTKEYPATH1 values located under the key path and returns their names as HUGETEXTLIST returned. Return value: On success HUGETEXTLIST, otherwise @ERROR.

@NTRegistrySetValue

Function Version 4.60

Sets the content of the value named TEXT TEXTVALUENAME2, under the key path TEXT TEXTKEYPATH1, to the content of the variable VALUE3. The following data types are supported (for VALUE3): TEXT TEXTLIST NUMBER (set as DWOR …

@OpenAgent

Function Version 4.50

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 …

@OpenAttachedFile

Function Version 4.60

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 …

@OpenDB

Function Version 1.90

Opens a database with the NOTESPATH NOTESPATH1 and liefert einen DBHANDLE returned. As of version 1.93, TEXT OPTIONS2 can be used to specify more detailed behavior. OPTIONS2: L=Locked (no further opening from another loc …

@OpenDesignNote

Function Version 1.90

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 …

@OpenFtSearch

Function Version 5.00

Opens in the database with the DBHANDLE DBHANDLE1 a full-text search with the search string TEXT TEXTQUERY2 and the options FN FNOPTIONS3. The parameter VIEWHANDLE VIEWHANDLESEARCHVIEW4 is reserved. This @Function is ava …

@OpenNoteByID

Function Version 1.90

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

Function Version 1.90

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

Function Version 2.10

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 …

@OpenNTComPort

Function Version 4.00

Opens the DEVICE with the OSCOMPORTNAME OSCOMPORTNAME und outputs einen OSCOMHANDLE for it. Only for the Engine under Windows!

@OpenOSComPort

Function Version 3.00

Opens the DEVICE with the OSCOMPORTNAME OSCOMPORTNAME und outputs einen OSCOMHANDLE for it.

@OpenOSFile

Function Version 1.91

Opens the OSFILE with the OSPATH OSPATH1 und outputs einen FILEHANDLE for it. TEXT MODE2 can be used to specify the open mode. MODE2: A=(Append)   Open for appending data B=(Binary)   No conversion from CR to CRLF or vic …

@OpenProfileNote

Function Version 4.60

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 …

@OpenQueue

Function Version 4.60

Opens the message queue named TEXT TEXTQUEUENAME. On success, a queue handle is returned; otherwise @ERROR.

@OpenView

Function Version 1.90

Opens in the database with the DBHANDLE DBHANDLE1 a view/folder named TEXT NAME2 (or with the NOTEID VIEWNOTEID) and returns the VIEWHANDLE returned. Options can be specified in the parameter FN FNFLAGS3 can be used to s …

@Password

Function Version 10.01

Generates from TEXT TEXTPASSWORD1 a hash, which is returned as TEXT . In case of an error, @Password @Error is returned. FN FNHASHTYPE2: 1 returns a hash like @Password in Notes. (Version compatible with Notes version >= …

@PDFExtractInvoiceXML

Function Version 10.10

Extracts the invoice XML embedded in a ZUGFeRD/Factur-X PDF file. The PDF data is processed directly from a BINBUFFER. No temporary file in the file system is required. The function searches the PDF document for an embed …

@Power

Function Version 1.90

Calculates FN/FNLIST FN1/FNLIST1 to the power of FN/FNLIST FN2/FNLIST2. Each element of FNLIST2 is applied to the corresponding element of FNLIST1 . If one list is shorter, its last element is used for all missing elemen …

@ProperCase

Function Version 1.90

Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in proper case, i.e. the first letter is uppercase and the following letters are lowercase.

@PrtVStack

Function Version 1.90

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 …

@PushAndReplace

Function Version 4.50

This @Function provides a special one-way replicator with additional replace logic. It was created for a customer-specific project requirement and is not intended as a replacement for classic Domino replication. It is in …

@PushWithFormula

Function Version 4.50

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 …

@PutQueue

Function Version 4.60

Places the message TEXT TEXTMESSAGE with priority FN FNPRIORITY into the message queue with queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR. FN FNPRIORITY: 1   = Highest priority …

@Rand

Function Version 5.00

Currently available only under NT! Returns a pseudo-random number between 0 and 32767.

@ReadACL

Function Version 4.50

This @Function creates an in-memory copy of the ACL of the database specified by DBHANDLE DBHANDLE and returns a VSPECHACL (HACL) handle to this copy. When the VSPECHACL handle is no longer required, it must be released …

@ReadAttachedFile

Function Version 4.60

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 …

@ReadBuffer

Function Version 5.00

Liest aus dem BINBUFFER with dem BUFFERHANDLE BUFFERHANDLE1 a record with length FN LENGTH3. This record is returned as a variable of the data type specified in TEXT RETTYPE2 . RETTYPE2: A=TEXT B=BINARY (derzeit as RICHT …

@ReadNTComPort

Function Version 4.00

Reads a value from the COM port identified by OSCOMHANDLE OSCOMHANDLE1 and returns it as the result of the @Function. The value to be read is expected to be of the type specified by TEXT RETTYPE2. Either one value is rea …

@ReadOSComPort

Function Version 3.00

RETTYPE2: A=TEXT B=BINARY (currently as RICHTEXT) N=NUMBER F=FLOAT L=FLOAT (converted long) D=FLOAT (converted DWORD) T=TIMEDATE STATUS4: 0=OK 1=Read Timeout expired 2=TEXT limit reached (only in TEXT mode) 32768=Error I …

@ReadOSFile

Function Version 1.91

Reads a record of length FN LENGTH3 from the OS file identified by FILEHANDLE FILEHANDLE1. This record is returned as a variable of the data type specified in TEXT RETTYPE2. If TEXT/TEXTLIST TEXT3/TEXTLIST3 is specified, …

@ReadVarOSFile

Function Version 1.91

Reads a variable from the OSFILE identified by FILEHANDLE FILEHANDLE1. The variable must have been written using @WriteVarOSFile, and is returned as the @Function result. The contents of a variable, including its name an …

@RecalculateNote

Function Version 1.90

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 …

@ReleaseACL

Function Version 4.50

This @Function releases a previously created VSPECHACL (HACL) and sets the handle contained in it to NULL. It should be called as soon as the in-memory copy of the ACL is no longer required. VSPECHACL HACL: A VSPECHACL h …

@ReleaseClass

Function Version 4.60

Releases the class(es) with the name(s) TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1. Return value: @Error   ->   An error occurred. TRUE   ->   All requested classes released. FALSE   ->   At least one of the classes could …

@ReleaseMutexSemaphore

Function Version 4.60

Releases the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE . On success, @True is returned; otherwise @ERROR. A mutex semaphore can be owned (requested) by only one task at a time. (This is u …

@RemoteConsole

Function Version 4.00

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.

@RenameFolder

Function Version 4.50

This @Function assigns to the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2 the name TEXT NEWFOLDERNAME3. ReturnWert: If the @Function was executed successfully, TRUE is returned; othe …

@ReorgACLPrivileges

Function Version 4.50

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 …

@ReorgList

Function Version 2.00

This @Function rearranges the elements of a list and returns the newly ordered list. TEXTLIST/FNLIST/TDLIST LIST1 is the list whose elements are to be rearranged. FNLIST SEQUENCE1 specifies the new order. LIST1 and SEQUE …

@Repeat

Function Version 1.90

Repeats the text in TEXT TEXT1 or in each element of TEXTLIST TEXTLIST1 until the count FN COUNT2 is reached, and optionally truncates the resulting texts after FN LENGTH3 characters.

@Replace

Function Version 1.90

Replaces in TEXT/TEXTLIST TEXT1/TEXTLIST1 all elements TEXT/TEXTLIST TEXT2/TEXTLIST2 with TEXT/TEXTLIST TEXT3/TEXTLIST3. Thus, TEXT2/TEXTLIST2 specifies a list of text fragments to be replaced by text fragments from TEXT …

@ReplaceSubString

Function Version 1.90

Replaces in TEXT/TEXTLIST TEXT1/TEXTLIST1 the strings specified in TEXT/TEXTLIST TEXT2/TEXTLIST2 with the corresponding element from TEXT/TEXTLIST TEXT3/TEXTLIST3. The optional parameter FN FNCMPMODE specifies the search …

@Replicate

Function Version 1.90

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 …

@ReplicateWithFieldException

Function Version 5.00

Deprecated! See @ReplicateWithFieldProtection Note : This text was machine-translated and may contain inaccuracies.

@ReplicateWithFieldProtection

Function Version 5.00

Replicates the database referenced by DBHANDLE1 with the database referenced by DBHANDLE2. FNLIST3 contains the replication rights. The first element specifies the rights for replication in the first database, and the se …

@ReplicateWithFormula

Function Version 3.08

Replicates the database referenced by DBHANDLE1 with the database referenced by DBHANDLE2. Only documents that match the Notes-compatible selection formula TEXT/TEXTLIST FORMULA3 are replicated. FORMULA3 can be passed as …