Engine Help: A
Filtered overview of the Engine Help documentation.
@Abs
Calculates the absolute value of FN/FNLIST FN1/FNLIST1.
@Accessed
Returns the time of the last access to the document with the NOTEHANDLE NOTEHANDLE1 back.
@Adjust
Changes the individual components of the time/date value TD/TDLIST TD1/TDLIST1 by the values specified in FN YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 . YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 is added to year/month/day/ho …
@ADSICloseSearchObject
Closes an object connection to an AD server and returns POTVAR.
@ADSIOpenSearchObject
Opens an object connection to an AD server and returns an ADSIHANDLE for the connection.
@ADSISearchObjectCloseSearch
Closes an ADSIHANDLE and releases the memory associated with the ADSISEARCHRESULTHANDLE ADSISEARCHRESULT. Returns POTVAR or @Error;
@ADSISearchObjectExecuteSearch
Executes the search and returns a ADSISEARCHRESULTHANDLE for the result. Rueckgabe ADSISEARCHRESULTHANDLE or @Error; ADSIHANDLE: ADSIHANDLE through which the connection was opened via @ADSIOpenSearchObject to the DC was …
@ADSISearchObjectGetColumnData
Retrieves the next column of the search result. Return: In case of an error, @Error; in case of success, TRUE; and if no further column is available, FALSE. TEXT ColName: Returns the column name. ColData: Where possible, …
@ADSISearchObjectGetFirstRow
Retrieves the first row of the search result. Return: In case of an error, @Error; in case of success, TRUE; and if no row is available anymore, FALSE. ADSIHANDLE: ADSIHANDLE through which the connection was opened via @ …
@ADSISearchObjectGetNextRow
Retrieves the next row of the search result. Return: In case of an error, @Error; in case of success, TRUE; and if no row is available anymore, FALSE. ADSIHANDLE: ADSIHANDLE through which the connection was opened via @A …
@ADSISearchPreferencesArrayAddScope
Sets the scope search preferences for an object connection to a DC and returns a status. Returns TRUE or @Error; FN FNSCOPE Values: ADS_SCOPE_BASE = 0 ADS_SCOPE_ONELEVEL = 1 ADS_SCOPE_SUBTREE = 2 ADSISPARRAY: Searc …
@ADSISearchPreferencesArrayApply
Applies the search preferences array ADSISPARRAY that was created via @ADSISearchPreferencesArrayInit was created to an ADSIHANDLE and thereby assigns the preferences. Returns TRUE or @Error; ADSIHANDLE: ADSIHANDLE throu …
@ADSISearchPreferencesArrayDestroy
Releases a search preferences array. ADSISPARRAY: Search-Preferences-Array that was created via @ADSISearchPreferencesArrayInit was created.
@ADSISearchPreferencesArrayInit
Initializes a search preferences array and returns it.
@AllDay
Returns the time/date value (TD) for any time. A comparison with any time is always TRUE.
@AnyAllDay
Returns the time/date value (TD) for any date and time. A comparison with any other time/date value is always TRUE.
@AnyDay
Returns the time/date value (TD) for any date. A comparison with any other date is always TRUE.
@APIServerName
Returns the name (TEXT) of the server on which this program is executed.
@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 …
@Author
Essentially analogous to Notes. If a field with the Notes V2.0/V2.1 Author data type is passed, the text part of this data type is returned as text. Note : This text was machine-translated and may contain inaccuracies.
AEF-Document
An AEF Document contains an Engine Batch Script program. This is the old name for an Engine Batch document, but it is still used in batch scripts and commands for compatibility reasons. Example image of an AEF Document: …
APIAddEngineToServerTasks
Entry in Notes.ini. This entry determines whether the Engine task name should be added to the Notes.ini entry ServerTasks. 0 = Do not add 1 = Add when the Engine is started for the first time 2 = Add each time the Engine …
APIAELicenseID
The entry in the NOTES.INI which contains the License ID created by @CrtAELicID. Only in the BETA-Version of the V1.90. Not valid from Release V1.90 on.
APICacheLogReport
Entry in the Notes.ini. When 1 is entered the API Log statements are buffered. Default:0.
APICompilerMaxIncludeDepth
Entry in NOTES.INI. This specifies the maximum nesting depth for INCLUDE (compiler keyword). Default:10.
APIConsoleReport
Entry in Notes.ini. If 1 is specified here, APILog statements are also output to the console; otherwise, only errors and the starting of new tasks are displayed. Default:1.
APIControlDB
Entry in the NOTES.INI. The Notes path of the APICTRL-DB (The Control Database of the APIEngine) on the server is entered here. This entry is required when APINoEngineINI=1.
APICreateTemplateAPIControlDB
Entry in NOTES.INI. This entry defines whether a template should be created from the APIControlDB when the Engine is booted (=1 default), or not (=0).
APICryptPreference
Entry in Notes.ini. If both an encrypted (crypted) PRC/IDF and an unencrypted PRC/IDF exist under the same name, this entry determines which PRC/IDF should be preferred. 0 = prefer unencrypted PRC/IDF. 1 = prefer encrypt …
APICTRL.NSF
The APICTRL.NSF is the Engine control database. The following documents: Event document Script document Import Script Document Batch document Specify to the Engine what should run when and where. WARNING: Any change to t …
APIDelayedMailAdr
Entry in the NOTES.INI. Specifies the default Delayed Tasks (PRG/OPP/DBP) warning mail address. If no address is specified, which is the default, no mail is sent. Default: No mail address.
APIDoSchedulerTasksInterval
Entry in the Notes.ini. Specifies the interval, in seconds, at which various scheduler tasks (OPP/DBP...) are executed. Default:10 (sec).
APIELReinitInterval
Entry in the Notes.ini. The interval for the initialisation of the API Control Database is entered here in seconds. (This only applies to ***UNIVERSAL*** PRG/DBP documents.) Default:21600 (=6 hours).
APIELUpdateInterval
Entry in the Notes.ini. The interval in which the API Control DB is searched, is entered in seconds here. Default:30.
APIFunctionDLLs
Entry in the Notes.ini. The DLLs in which the @Functions are entered are defined here. The first character of DLL's name identifies the platform: $=OS/2 16Bit I=OS/2 32Bit N=Windows 32Bit Default:$AEFUN1. (Example for OS …
APIHierarchicalNames
Entry in the Notes.ini. If 1 is entered the [CN] of the server is only noted and no @Uppercase is run. Default:0.
APIIDDisplayInfo
Entry in the Notes.ini. ID-Info Display Flags. 2 Show extended information (ID number/date/flags); 4 Show the ID mode in each API log entry; (To combine multiple flags, the values must be added). Default:1.
APIInitCtrlDocCache
Entry in the Notes.ini. Defines whether PRC, IDF, and AEF documents are stored as references on a VSTACK when the Engine starts. If one of these documents is required, a reference to this document is automatically create …
APIIsAliveInterval
Entry in Notes.ini. Number of seconds between two updates of the APIIsAlive entry. This variable in Notes.ini allows remote control of whether the Engine task is running correctly. Default:900.
APIJOB System Fields
TEXT AefName The title of an AEF document in APICTRL.NSF / this document is started. TEXT PrcName The title of a PRC document in APICTRL.NSF / this document is started. TEXT/RT AefFile An executable AEF program / the AEF …
APIJobDB
Entry in the NOTES.INI. The Notes path for the APIJOB DB on the server is given here.
APIJobDBAllow
OBSOLETE !!! SEE MailInAllow... Entry in the NOTES.INI. The groups in the server's address book which contain members who are supposed to have the rights to carry out program-Starts using Dokument-Mail-In in the APIJOB-D …
APIJobDBJobDel
Entry in the NOTES.INI. This confirms whether a document in the APIJOB-DB which is sent after execution should be generally deleted (1) or assigned "DONE" (2). Examples: APIJobDBJobDel=1 (always delete) APIJobDBJobDel=2 …
APIKeyFileName
Entry in the NOTES.INI. The path of the server's APIEngine ID is entered here.
APILOG
The API-Log is a database in the API-Engine that records and reports user activities. All exported data using the @LogReport, etc. are arranged in a lower order in the API-Log. The API-Engine Starting and Ending Reports …