Engine Help: M
Filtered overview of the Engine Help documentation.
@MagicNumber
Returns a MagicNumber for the value FN FN1.
@MainDatabase
Without parameters, @MainDatabase the DBHANDLE for the current main database (AEF DATABASE Statement). With parameters, @MainDatabase works like @OpenDB, but the opened database becomes the new main database. The previou …
@Max
Returns the maximum of FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2. To do this, each element of FNLIST1 is compared with the corresponding element of FNLIST2. If one list is shorter, its last element is used for all …
@MaxPos
Returns the position of the first occurrence of the largest element in FN/FNLIST FN1/FNLIST1. By specifying FN FROM2 and FN TO3 a search range can be defined. If it exceeds the list size, it is reduced to the maximum pos …
@Member
Returns the position at which TEXT/FN TEXT1/FN1 in TEXT/TEXTLIST/IDLIST TEXT2/TEXTLIST2/IDLIST2 is contained in TEXTLIST1/IDLIST1 contains no elements, the result is 0. If @Member is called with PositionList3 then the pa …
@Middle
Returns FN LENGTH3 characters from inside TEXT/TEXTLIST TEXT1/TEXTLIST1. A start position can be selected FN POSITION2 (starting at 0!) or a TEXT TEXT2 can be specified as the position. Note that TEXT2 is not included in …
@MiddleBack
Returns FN LENGTH3 characters from inside TEXT/TEXTLIST TEXT1/TEXTLIST1. A start position can be selected FN POSITION2 (starting at 0!) or a TEXT TEXT2 can be specified as the position. Note that TEXT2 is not included in …
@MimePartAdd
A new MIMEPART segment is appended to HUGEMIMEPART MIMEPART1; the extended MIMEPART field is returned again. FN FNFLAGS2 Flag Hex Dec Kommentar MIME_PART_HAS_BOUNDARY 0001 00001 MIME_PART_HAS_HEADERS 0002 …
@MimePartGet
Returns information about a MIMEPART segment of HUGEMIMEPART MIMEPART1. FN FNSEGMENTNR2 Return FN FNFLAGS3 Flag Hex Dec Kommentar MIME_PART_HAS_BOUNDARY 0001 00001 MIME_PART_HAS_HEADERS 0002 00002 MIM …
@Min
Returns the minimum of FN/FNLIST FN1/FNLIST1 and FN/FNLIST FN2/FNLIST2. To do this, each element of FNLIST1 is compared with the corresponding element of FNLIST2. If one list is shorter, its last element is used for all …
@MinPos
Returns the position of the first occurrence of the smallest element in FN/FNLIST FN1/FNLIST1. By specifying FN FROM2 and FN TO3 a search range can be defined. If it exceeds the list size, it is reduced to the maximum po …
@Minute
Returns the minutes of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = …
@Modified
Returns the time of the last modification of the document with the NOTEHANDLE NOTEHANDLE1.
@Modulo
Calculates the remainder of the integer division of FN/FNLIST FN1/FNLIST1 durch FN FN2. Decimal places are ignored and no negative remainders are returned; therefore FN1/FNLIST1 and FN2 should be positive integers.
@Month
Returns the month of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = TE …
@MoveFolder
This @Function moves the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2, under the folder mit the VIEWHANDLE VIEWHANDLEPARENTFOLDER3. The folders must be of the same type (shared/privat …
@MySQLClose
Closes a VSPECMYSQL MySQLHandle. The VSPECMYSQL MySQLHandle is returned by @MySQLInit. Return: On success, a closed VSPECMYSQL MySQLHandle; otherwise @Error.
@MySQLClosePreparedStatement
Closes a MySQLPreparedStatementHandle. Return: On success, a closed PreparedStatement handle; otherwise, @Error.
@MySQLConnect
Establishes a connection to the MySQL server. Should be called after @MySQLoptions. The VSPECMYSQL MySQLHandle is provided by @MySQLInit. TEXT Host (for local "" (NULLSTR)) TEXT User (may also be "" (NULLSTR)) TEXT Passw …
@MySQLCreatePreparedStatement
Creates a PreparedStatement query. Such a query represents a kind of template that can then be completed with data to form a complete query and executed. This function is intended for repeated execution of similar querie …
@MySQLExecutePreparedStatement
Executes a prepared query using the MySQLPreparedStatementHandle. After the handle, the parameters are specified in the order corresponding to the query. Return: TRUE on success, otherwise @Error. WARNING: The MySQLPrepa …
@MySQLFetchColumn
Retrieves a column from the stored result of an @MySQLQuery request. The column number is specified in FN FNColumnNumber. If the optional parameter FN FNVPR is specified, the result is additionally returned in the variab …
@MySQLFetchColumnLocalTD
Retrieves a column from the stored result of an @MySQLQuery request. The column number is specified in FN FNColumnNumber. Time values are converted to the local time zone. (This is a workaround function for time zone iss …
@MySQLFetchRow
Fetches one row from the current position (see @MySQLSeekResult) of a stored result of a @MySQLQuery query. The VSPECMYSQLRES MySQLResultHandle is provided by @MySQLQuery. After the current row has been retrieved using t …
@MySQLFreeResult
Deletes a stored result of an @MySQLQuery request. The VSPECMYSQLRES MySQLResultHandle is returned by @MySQLQuery. Return: On success, a closed VSPECMYSQLRES MySQLResultHandle is returned; otherwise @Error;
@MySQLGetAffectedRows
Returns the number of rows affected by the last @MySQLQuery call. This function should be called immediately after @MySQLQuery and with the MySQLResultHandle variable, or, if no result is retrieved, with the MySQLHandle …
@MySQLGetAffectedRowsPreparedStatement
If the query contains an INSERT, UPDATE, or DELETE statement, the number of rows affected by this statement is returned. Return: On error, @Error; otherwise, the retrieved value.
@MySQLGetFieldDef
Returns detailed information about a field definition (for a column) in the stored result of an @MySQLQuery request. The field number is specified in FN FieldIndex, starting with 0. RetName TEXT Name of the field. RetTyp …
@MySQLGetInsertID
Returns the generated ID of an AUTOINCREMENT ID column if the last @MySQLQuery call generated such an AUTOINCREMENT ID. This function should be called immediately after @MySQLQuery and with the same MySQLHandle variable. …
@MySQLGetLastInsertIDPreparedStatement
If the query contains an INSERT statement and affects an AUTO_INCREMENT ID column, the generated ID is returned. Return: On error, @Error; otherwise, the retrieved value.
@MySQLGetNumFields
Returns the number of fields (columns) in the stored result of an @MySQLQuery or @MySQLExecutePreparedStatement request. Return: On success, the number of fields; otherwise, @Error.
@MySQLGetNumRows
Returns the number of rows of a stored result of a @MySQLQuery or @MySQLExecutePreparedStatement query. Return: On success FN Count, otherwise @Error;
@MySQLInit
Initializes MySQL and returns a VSPECMYSQL MySQLHandle; this is required by other MySQL @Functions. Return: On success, returns a VSPECMYSQL MySQLHandle, otherwise @Error;
@MySQLOptions
Sets the options. Should be called after @MySQLInit. Currently, only the option MYSQL_READ_DEFAULT_GROUP is set. If only one parameter is specified, this value is set to "engine"; otherwise it is set to the specified TEX …
@MySQLQuery
Executes a MySQL query. If the query returns a result, it can be stored in the VSPECMYSQLRES MySQLResultHandle. If the query contains an INSERT statement and it affects an AUTOINCREMENT ID column, the generated ID is ret …
@MySQLSeekResult
Sets the current position, respectively row, in a stored result of an @MySQLQuery request. WARNING: Counting starts at 0! Return: TRUE on success, otherwise @Error.
@MySQLThreadEnd
This @Function must be called before a thread is terminated! NOTE: This @Function releases the MySQL context! After calling @MySQLThreadEnd, no further MySQL functions may be called.
@MySQLThreadInit
Initializes a thread for MySQL. @MySQLInit or @MySQLConnect also initialize a thread. Note : This text was machine-translated and may contain inaccuracies.
MAIN
MAIN is a special NOTEHANDLE (a special variable group) that, in an Import Script, contains the fields (variables) of the imported record. WARNING: MAIN cannot be used in @Functions that explicitly require a NOTEHANDLE a …