EN 843 documents

Engine Help: Function

Filtered overview of the Engine Help documentation.

← Back to Engine Help overview

581 documents found

@MaxPos

Function Version 1.90

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

Function Version 1.90

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

Function Version 1.90

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

Function Version 1.90

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

Function Version 10.10

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

Function Version 10.10

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

Function Version 1.90

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

Function Version 1.90

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

Function Version 1.90

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

Function Version 1.90

Returns the time of the last modification of the document with the NOTEHANDLE NOTEHANDLE1.

@Modulo

Function Version 1.90

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

Function Version 1.90

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

Function Version 4.50

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

Function Version 5.00

Closes a VSPECMYSQL MySQLHandle. The VSPECMYSQL MySQLHandle is returned by @MySQLInit. Return: On success, a closed VSPECMYSQL MySQLHandle; otherwise @Error.

@MySQLClosePreparedStatement

Function Version 5.00

Closes a MySQLPreparedStatementHandle. Return: On success, a closed PreparedStatement handle; otherwise, @Error.

@MySQLConnect

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

Returns the number of rows of a stored result of a @MySQLQuery or @MySQLExecutePreparedStatement query. Return: On success FN Count, otherwise @Error;

@MySQLInit

Function Version 5.00

Initializes MySQL and returns a VSPECMYSQL MySQLHandle; this is required by other MySQL @Functions. Return: On success, returns a VSPECMYSQL MySQLHandle, otherwise @Error;

@MySQLOptions

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

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

Function Version 5.00

Initializes a thread for MySQL. @MySQLInit or @MySQLConnect also initialize a thread. Note : This text was machine-translated and may contain inaccuracies.

@Name

Function Version 3.00

Basically analogous to Notes. Difference: The KEYWORD must be enclosed in quotation marks: Therefore, instead of [CN] "[CN]" must be specified etc. KEYWORD: [O] [C] [OU1] [OU2] [OU3] [OU4] [CN] [Canonicalize] [Abbreviate …

@Neg

Function Version 1.90

Negates FN/FNLIST FN1/FNLIST1, and returns the result as FLOAT/FLOATLIST.

@Newline

Function Version 1.90

Returns a line break that can be used in TEXT/TEXTLIST can be used.

@NewOID

Function Version 1.93

Returns a OID for a new document in a database with the DBHANDLE DBHANDLE1.

@NotesIDFileCloseCertifierCtx

Function Version 4.50

The @Funktion closes the Certifier NotesID Context-Handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 and returns VSPECPOTVAR. Return value: On success VSPECPOTVAR is returned; otherwise @ERROR.

@NotesIDFileEncodePassword

Function Version 4.50

The @Funktion encodes the plain-text password TEXT TEXTPASSWORD1 and returns the encoded password as VSPECENCPASSWORD. In case of an error, @ERROR is returned.

@NotesIDFileGetInfo

Function Version 5.00

This @Funktion returns various information about the Notes ID file with the OSPATH OSPATH1. If the ID file is password-protected, @NotesIDFileGetInfo should not be used. In that case, the password is requested on the ser …

@NotesIDFileNewCertifier

Function Version 1.90

Creates a new Notes certifier ID. Optionally, an entry can also be created in the Name and Address Book, and a mail file can be created for the new user. The process is controlled primarily by FN IDTYPE and FN FLAGS. All …

@NotesIDFileNewServer

Function Version 4.60

Creates a new Notes server ID. Optionally, an entry can also be created in the Name and Address Book. The process is controlled primarily by FN IDTYPE and FN FLAGS. All other parameters are largely optional TEXT paramete …

@NotesIDFileNewWorkstation

Function Version 4.50

Creates a new Notes ID. Optionally, an entry can also be created in the Name and Address Book, and a mail file can be created for the new user. The process is controlled primarily by FN IDTYPE, FN MAILSYSTEM and FN FLAGS …

@NotesIDFileOpenCertifierCtx

Function Version 4.50

This @Funktion öffnet the Cdertifier Context (Certifier Notes ID) with the OSPATH OSPATH1. In parameter VSPECENCPASSWORD VSPECENCPASSWORD2 the encoded password must (see @NotesIDFileEncodePassword) be passed, if the Note …

@NotesIDFileReCertifyID

Function Version 5.00

This @Funktion recertifies the Notes ID with the OSPATH OSPATH4 of the certifier Notes ID that is assigned to the certifier context handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 has been assigned (see @NotesIDF …

@NotesIDFileSetCtxExpirationTD

Function Version 4.50

With this @Funktion the certifier context handle VSPECCERTIFIERCTXHANDLE VSPECCERTIFIERCTXHANDLE1 an expiration date (TD TDEXPIRE2) for newly created Notes IDs. All IDs subsequently created with this certifier context ha …

@Now

Function Version 1.90

Returns the current date/time value. If the @Function with the optional parameter FN FN = 1 is called, the system time is returned instead of the Domino server time (these may differ!).

@NTRegistryDeleteKey

Function Version 4.60

Deletes the SUBKEY named TEXT TEXTSUBKEYNAME2 under the key path TEXT TEXTKEYPATH1 together with all values contained in it. Return value: On success TRUE, otherwise @ERROR.