Engine Help: Command
Filtered overview of the Engine Help documentation.
DATABASE
DATABASE specifies the main database which is related to the following commands. DB-Filename is the path and name of the database.
DEL VAR
Deletes the Global Variable VariableName[GLOBAL] from the hard disk.
DISPLAY ALLOC MEM
DISPLAY ALLOC MEM returns the size (in bytes) of dynamic memory currently being physically used by the program.
DISPLAY OPEN DBS
DISPLAY OPEN DBS returns the number of databases which are currently open due to PROCESSING.
DISPLAY OPEN NOTES
DISPLAY OPEN NOTES returns the number of documents which are currently open due to PROCESSING.
DISPLAY OPEN VIEWS
DISPLAY OPEN VIEWS returns the number of views which are currently open due to PROCESSING.
DISPLAY PRC SIZE
DISPLAY PRC SIZE returns the size of a program in bytes. 64512 Bytes is the maximum!!
DISPLAY TITLE
DISPLAY TITLE returns the current database title on the server console and in the API log document.
DISPLAY USED MEM
DISPLAY USED MEM returns the number of bytes in dynamic memory currently being used by the program.
DISPLAY VACANT MEM
DISPLAY VACANT MEM returns the number of bytes in dynamic memory which is currently not being used by the program.
ENCRYPT IDF
ENCRYPT IDF encrypts the IDF document idf_file and creates a new IDF document, new_idf_file, which contains the encrypted information. The comment field can contain info about encrypted servers. Only encrypted IDF docume …
ENCRYPT PRC
ENCRYPT PRC encrypts the PRC document prc_file and creates a new PRC document, new_prc_file, which contains the encrypted information. The comment field can contain info about encrypted servers. Only encrypted PRC docume …
END
END marks the end of an AEF program.
FREE MEMORY
Deletes all global variables (VariableName[GLOBAL]) from memory.
IMPORT IDF
IMPORT IDF imports data from the file import_file into Notes documents in the current main database. The structure and conversion of the data is specified in the IDF file idf_file.
PROCESS
Calls the processing macro prc_file.
SET CRYPT DATATYP
Determines the data type for the encrypted API Engine fields. Text is the default. All fields, saved and encrypted after this command, are saved with this data type. DataTypText: "RT" "TEXT" Example1: SET CRYPT DATATYP:" …
SET CRYPT SUMMARY
Determines whether or not the SUMMARY flag is to be set for API engine encryted fields. The default setting is 1. All fields which are encrypted and saved using this command are saved with a SUMMARY flag depanding on the …
SET VAR
Attaches a global variable to the processing (analog) (VariableName[GLOBAL]:=Item;). DataTyp returns the DatenTyp of the variable and a ListSeperator (always one line only) returns the separating symbol for a list. Possi …
SET VAR ENV
Attaches a global variable to the processing (analog) (VariableName[GLOBAL]:=@Environment(EnvironmentVariableName);). DataTyp returns the DatenTyp of the variable and a ListSeperator (always one line only) returns the se …
SET VAR SHARED
Attaches a global variable to the processing (analog) (VariableName[SHARED]:=Item;). DataTyp returns the DatenTyp of the variable and a ListSeperator (always one line only) returns the separating symbol for a list. Possi …
SWITCH LOGDOC
After the execution of SWITCH LOGDOC, the logging will be continued in a follwing APILOG-document.