Engine Help: Text
Filtered overview of the Engine Help documentation.
APISQLNeededDLLs
Entry in the Notes.ini. The dlls necessary to run the SQL option are entered here (optional). Default:SQLIBMNB,SQLOS2,SQLPIPE,SQLSPX,SQLSPX13,SQLNBIOS,SQLGCI.
APISQLNeededFiles
Entry in the Notes.ini. The files necessary to run the SQL Option are entered here (optional). Default:SQL.INI,MESSAGE.SQL,COUNTRY.SQL,ERROR.SQL.
APITerminationMailAdr
Entry in the NOTES.INI. This entry specifies the default Abnormal Termination warning mail address. If no address is specified (default), no mail is sent. Default:No Mail Address.
APITimeoutMailAdr
Entry in the NOTES.INI. This entry specifies the default Timeout warning mail address. Default:APITimeoutMessages.
APIUpdateListFieldName
Entry in NOTES.INI. This entry specifies the field name and the maximum number of entries for the Engine Script update field. During a document update (by an Engine Script), the server name and the time are appended to t …
CALL
See STRUCTURAL KEYWORDS.
CALLFAST
See STRUKTURELLE KEYWORDS.
CALLSAVE
See STRUKTURELLE KEYWORDS.
Comments in Engine Script
In Engine Scripts and in Engine Import Scripts (SECTION INIT/SECTION PROCESSING/SECTION EOF) comments can be specified. A comment is introduced by /* and terminated by */. Such a comment can appear anywhere in the progra …
Constant
A string constant is specified in " quotation marks.
Control Database
See APICTRL.NSF.
Control Document Names
The syntax for a Control Document Name is: ServerName!!DocumentName ServerName specifies the name of the Engine Notes server on which this document is to be executed. If ServerName is left empty (e.g. !!TEST_UNIVERSAL), …
Control Documents
Control documents are: Batch documents Script documents Import Script documents Event documents These are control documents in the Engine control DB (APICTRL.NSF). Note : This text was machine-translated and may contain …
Data type AGENTHANDLE
A complex data type which represents a database agent.
Data type ATTACHLIST
Represents a list of attachments on a document. This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type BINBUFFER
A handle to a binary buffer. It can hold large amounts of binary data. Note : This text was machine-translated and may contain inaccuracies.
Data type BOOL
BOOL is not actually a separate data type, but is of type NUMBER and denotes its use with a special meaning in logical expressions. A 0 is equal to FALSE, i.e. logically false; all other values (preferably 1) are TRUE, i …
Data type CEXPRESSION
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type CLASS
A handle to a class. Note : This text was machine-translated and may contain inaccuracies.
Data type DBCLASS
DBCLASS is TEXT type and has the following meaning: "NSF" Standard Database "NSG" Giant Database 200 MB "NSH" Huge Database 300 MB "NTF" Template Database "NSX" Test Database "DSK" Desktop Database "NCF" No …
Data type DBHANDLE
A complex data type which represents a database.
Data type DNFIELD
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type ERRORITB
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type EXEKEYWORD
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type FDEF
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type FILEHANDLE
A complex da type which represents an OSFile. See: @OpenOSFile @CloseOSFile @WriteOSFile @ReadOSFile
Data type FLOAT
Analogous to a Notes data type number
Data type FLOATLIST
Analogous to a Notes data type number list. Maximun 8063 elements.
Data type FN
Synonym for "Data type FLOAT or NUMBER"
Data type FNLIST
Synonym for "Data type FLOATLIST or NUMBERLIST"
Data type FTPNT
A handle to an FTP connection under Windows. Note : This text was machine-translated and may contain inaccuracies.
Data type FTSHANDLE
A handle to a full-text search. Note : This text was machine-translated and may contain inaccuracies.
Data type GDIMGPTR
A handle to a GD image. Note : This text was machine-translated and may contain inaccuracies.
Data type HLLCOMHANDLE
HLL-COM Handle. Note : This text was machine-translated and may contain inaccuracies.
Data type HUGEITEM
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type HUGERT
Notes stores rich text in a document as a series of fields with the same name. In the Engine, these are represented by the VHUGEHUGERT data type. This means that, for example, the Body field can be addressed directly thr …
Data type HUGETEXTLIST
A data type for storing a list of TEXT values. The capacity of HUGETEXTLIST, approximately 991 MB, is significantly larger than the capacity of TEXTLIST, approximately 64 KB. Unlike TEXTLIST, however, this data type is p …
Data type ID
A data type used to savea NOTEID. Implemented as FLOAT at the moment
Data type IDLIST
A data type for storing a list of NOTEIDs. This data type is a HUGE data type; such data types can hold a significantly larger amount of data. In this case, it is approximately 64 million entries. Note : This text was ma …
Data type IDXL
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type IIDLIST
A data type for storing a sort-pattern list of NOTEIDs. (IndexedIDList) This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type LINKLIST
A list of doc links. This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type MIMEPART
Notes stores MIME part fields in a document as a series of fields with the same name. In the Engine, these are represented by the data type VHUGEMIMEPART. This means that, for example, a MimePart Body field can be addres …
Data type MULTIGETVARHANDLE
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type MULTISETVARHANDLE
This is an internal data type. Note : This text was machine-translated and may contain inaccuracies.
Data type MUTEXSEMHANDLE
A handle to a mutex semaphore. Note : This text was machine-translated and may contain inaccuracies.
Data type MYSQL
A handle to a MySQL connection. Note : This text was machine-translated and may contain inaccuracies.
Data type MYSQLPREPSTAT
A handle to a MySQL prepared statement. Note : This text was machine-translated and may contain inaccuracies.
Data type MYSQLRES
A handle to a MySQL result. Note : This text was machine-translated and may contain inaccuracies.
Data type NOTECLASSES
A NUMBER variable for specifying multiple note classes with the following meaning: DEC BIT Meaning 00000 XX No Notes 00001 01 Documents 00002 02 Policy-Note 00004 03 Form-Note 00008 04 View-Note 0 …
