Engine Help: Function
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.
@Beep
Generates a beep on the server console.
@BitAnd
Performs a bitwise logical AND on FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2 from. (A 32-bit value is used internally.)
@BitOr
Performs a bitwise logical OR on FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2 from.
@BitVektor
Returns a bit vector (NUMBER) in which the bits specified in FN/FNLIST FN1/FNLIST1 are set.
@BitXor
Performs a bitwise logical EXCLUSIVE OR on FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2 from.
@BoolNeg
Negiert FN/TEXT FN1/TEXT1; the result is always of type NUMBER is. When using TEXT1 an empty text is equivalent to FALSE and any non-empty text is equivalent to TRUE.
@Break
Ohne Parameter: Terminates a program currently being processed at the point where it occurs. In addition, execution of the AEF is aborted. Mit Parameter (Ab V3.06): FN FN1 = 1: Wie ohne Parameter. FN FN1 = 2: Terminates …
@BroadcastNewMail
Sends the notification about the receipt of new mail to the workstation of the user named TEXT TEXT1. ACHTUNG: For this, the server that sends this notification must be configured as the mail server on the user's worksta …
@BuildList
Creates a list with FN COUNT2 identical elements FN/TEXT/TD/ID FN1/TEXT1/TD1/ID1.
@BuildNamedDocKeyLists
This @Function creates two corresponding lists (HUGETEXT RETHTL and IDLIST RETIDL). In the list HUGETEXT RETHTL the contents of the fields are returned sorted alphabetically, from the documents specified by the selection …
@CacheLogReport
Aktiviert or deaktiviert abhaengig vom Argument FN STATE1 buffering of LogReport statements (including @LogReport). The @Function returns the activation state of buffering as the result. STATE1: 0 = buffering off. 1 = bu …
@CacheLogReportUpdateInterval
Sets the interval (FN1) at which, when @CacheLogReport is enabled, the APILog entry is updated. @CacheLogReportUpdateInterval always returns the current interval. (For FN1=0 only the current interval is returned.)
@CallDEFFNFunction
Calls the GLOABLe DEFFN function named TEXT TEXTGLOBALGFUNNAME and the following parameters. The return parameters are determined by the definition of the DEFFN function definition -> see FUNKTIONEN. The GLOBALe DEFFN fu …
@CallIDF
Calls an IDF document with the TEXT IDFNAME1 as sub-processing. The file with the OSPATH OSPATH2 is imported. ACHTUNG: Local variables from the main processing are not accessible in the program called by @CallIDF, and vi …
@CallPRC
Calls a PRC document with the TEXT PRCNAME1 as sub-processing. ACHTUNG: Local variables from the main processing are not accessible in the program called by @CallPRC, and vice versa. Data (variables) can only be exchange …
@Char
Converts the ASCII code specified in FN/FNLIST FN1/FNLIST1 specified ASCII code into the corresponding character, or into a list of characters.
@CheckDefine
Checks whether a "term" (which can be used for conditional compilation) is defined or not. If the "term" is defined, @CheckDefine NUMBER 1 (TRUE) back. If the "term" is not defined, @CheckDefine NUMBER 0 (FALSE) back. TE …
@CheckHandle
Checks whether VIEWHANDLE/NOTEHANDLE/DBHANDLE/FILEHANDLE... VIEWHANDLE1/NOTEHANDLE1/DBHANDLE1/FILEHANDLE1... is an open handle. If yes, TRUE returned, otherwise FALSE. FILEHANDLE can only be checked as of version 1.93.
@ClearFolder
This @Function removes all documents in the DB with the DBHANDLE DBHANDLE1, from the folder with the VIEWHANDLE VIEWHANDLEFOLDER2. (The documents are only removed from the folder and not deleted from the DB.) ReturnWert: …
@ClearTaskTimeout
Disables task timeout monitoring for the task that @ClearTaskTimeout onruft. The return value of @ClearTaskTimeout is in the case of success NUMBER 1, otherwise @ERROR.
@Clock
Returns the milliseconds elapsed since the Engine was started.
@CloseAgent
Closes the agent (filter) with the AGENTHANDLE AGENTHANDLE1 and returns the closed AGENTHANDLE back.
@CloseAttachedFile
Closes the file attachment with the OBJECTFILEHANDLE OBJECTFILEHANDLE1 and returns the closed OBJECTFILEHANDLE back.
@CloseDB
Closes a previously opened database with the DBHANDLE DBHANDLE1 and returns the closed DBHANDLE1 As of version 1.93, TEXT OPTIONS2 more specific or additional behavior can be specified. OPTIONS2: S: Also closes the sessi …
@CloseFtSearch
Closes a previously opened full-text search with the FTSEARCHHANDLE FTSEARCHHANDLE1 and returns the closed FTSEARCHHANDLE1.