Engine Help Category: Text
Filtered overview of the Engine Help documentation.
@APIServerName
Returns the name (TEXT) of the server on which this program is executed.
@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.
@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.
@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.
@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 …
@CloseMutexSemaphore
Closes the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE. On success a closed mutex semaphore-Handle (MSH) is returned, otherwise @ERROR. A mutex semaphore can be owned (requested) by only on …
@CloseQueue
Closes the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR.
@Contains
Determines whether in TEXT/TEXTLIST TEXT1/TEXTLIST1 the TEXT TEXT2 or an element of TEXTLIST TEXTLIST2 is contained wholly or partially and returns TRUE if this is the case. An empty TEXTLIST1, which cannot contain anyth …
@CountListElement
Adds to the TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 at FN POSITION2 the element TEXT/FN TEXT3/FN3 to it. In the case of TEXT1/FN1 is the only valid POSITION2 the value 1 is possible. Only elements of matching …
@CreateMutexSemaphore
Creates a mutex semaphore named TEXT TEXTSEMAPHORENAME. On success, a mutex semaphore handle (MSH) is returned; otherwise @ERROR. A mutex semaphore can be owned (requested) by only one task at a time. (This is used to al …
@CreateQueue
Creates a message queue named TEXT TEXTQUEUENAME. On success, TRUE is returned; otherwise @ERROR. A message queue is used for inter-task communication. The message queue can be opened by several tasks (see @OpenQueue) an …
@CreateQuietTask
Creates a new Engine task the the GLOBAL function named TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME executes. If @CreateQuietTask with a TEXTLIST is called as the first parameter, the first element mu …
@CreateQuietTaskNoWait
Creates a new Engine task the the GLOBAL function named TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME executes. If @CreateQuietTask with a TEXTLIST is called as the first parameter, the first element mu …
@CreateTask
Creates a new Engine task the the GLOBAL function named TEXT/TEXTLIST TEXTGLOBALFUNCTIONNAME/TEXTLISTGLOBALFUNCTIONNAME executes. If @CreateTask with a TEXTLIST is called as the first parameter, the first element must co …
@CutList
TEXT TEXT2 is split into the lengths specified in FN/FNLIST FN1/FNLIST1 and returned as TEXTLIST is returned. If TEXTLIST TEXTLIST3 is present, in the case of 0 (NULL) in FN/FNLIST FN1/FNLIST1 the corresponding element f …
@DebugFollowFun
Defines @functions whose INPUT and OUTPUT parameters should be documented when called. It must with the KEYWORD DEBUG the mode "FOLLOW" must be activated so that the list defined with @DebugFollowFun is defined must also …
@DebugFollowVar
Defines variables that should be documented when used. It must with the KEYWORD DEBUG the mode "FOLLOW" must be activated so that the list defined with @DebugFollowVar is defined must also be taken into account. @DebugFo …
@Define
Defines a "term" that can be used for conditional compilation. Unlike the keyword DEFINE is @Define at runtime (and only if this @Define is executed) effective. TEXT1 must not contain spaces (" ") or special characters ( …
@DeleteEnvironment
Deletes the environment variable TEXT TEXT1 physically from NOTES.INI. Returnvalue: 1 = variable could are deleted. 0 = variable not present. @Errro... = An error occurred; the variable was not deleted.
@DigitsToText
Converts the ASCII-CHAR values in TEXT/TEXTLIST TEXT1/TEXTLIST1 to the corresponding ASCII texts and returns them as TEXT/TEXTLIST. The second parameter specifies the number system in which the ASCII-CHAR values in TEXT1 …
@Elements
Returns the number of elements of FNLIST/TEXTLIST/TDLIST/IDLIST FNLIST1/TEXTLIST1/TDLIST1/IDLIST. If no list is passed to the @Function as an argument, the @Function result is 1.
@Environment
Returns the value of the environment variable TEXT/TEXTLIST TEXT1/TEXTLIST1.
@ExpandGroups
In TEXT/TEXTLIST TEXT1/TEXTLIST1, all specified group names are replaced by their members. Unknown group names are retained, and the resulting list is returned as the @Function result. TEXTLIST TEXTLIST2 additionally ret …
@Explode
Splits the TEXT/TEXTLIST TEXT1/TEXTLIST1 into a TEXTLIST. At each occurrence of a space, the TEXT1 or each element of TEXTLIST1 is separated and made into its own element. TEXT SEPTEXT2 can be used to specify a different …
@GetDataType
Returns the data type of the variable VAR1. Data type: Return value: TEXT A TEXTLIST AL NUMBER N NUMBERLIST NL FLOAT F FLOATLIST FL TD T TDLIST TL RT (RICHTEXT) RT ID I IDLIST IL UNIDLIST …
@GetEngineTasks
Returns a list (TEXTLIST) the Engine tasks active when the @function is called.
@GetFieldFlags
Returns the Notes field flags of a varifromle. Field-Flags: 1 SIGN 2 SEAL 4 SUMMARY 16 SEALED 32 READ/WRITE-ACCESS 64 NAMES 256 PLACEHOLDER 512 PROTECTED 1024 READ-ACCESS Practical examples of combinati …
@GetLastNotesErrorCode
Returns the Notes error code of the last Notes function of this task as FN. (This can therefore aso be NOERROR=0.) See aso @GetNotesErrorString.
@GetListElement
Returns the element an FN/FNLIST POSITION2/POSITIONLIST2 of FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/ID/IDLIST/HUGETEXTLIST/UNIDLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/ID1/IDLIST1/HUGETEXTLIST1/UNIDLIST1, where in the case …
@GetProfileField
Returns the contents of the profile field named TEXT TEXTFIELDNAME, for the user named TEXT TEXTUSERNAME (which may also be ""), taking into account the Profile-Form with the name TEXT TEXTPROFILEFORMNAME from the databa …
@GetQueue
Gets the next message from the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, the message (TEXT) is returned, otherwise @ERROR (one-parameter version only, otherwise "" (NULLSTRING)). FN FN …
@GetServerStats
Gets the statistics entries of the server TEXT TEXT1 and returns them as TEXTLIST is returned. With the optional parameter TEXT TEXT2 the facility can be restricted so that only entries from this area are returned. With …
@GetSessionID
Returns a new SessionID.
@GetThreadID
Returns the ThreadID (FN) of the thread whose script executes this @Function. The optional parameter FN FNTYPEOFTASKID determines whether the operating-system ThreadID or the Engine-internal TaskID (shown, for example, b …
@GetThreadIDText
Returns the ThreadID of the thread as TEXT whose script executes this @Function.
@GetVar
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVarWithFieldFlags
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVStackPath2GFun
Returns the prefix for the access path of a variable stored within the thread copy of a global function. This could be used, for example, to assign default values for local parameters. However, this function should be av …
@HashPassword
Generates a hash from TEXT TEXTPASSWORD1 and returns it as TEXT. In case of an error, @HashPassword returns @Error. This @Function generates a hash that is compatible with a hash generated by the @Function @Password usin …
@HookUpdateFields
With this @Function, the fields changed by the Engine script of the global HOOK function of the document with the NOTEHANDLE NOTEHANDLE1 are transferred back into the document.
@Implode
Joins TEXT/TEXTLIST TEXT1/TEXTLIST1 into a single TEXT . A space is inserted between all joined elements. With TEXT SEPTEXT2, a different separator text can be selected instead.
@IndexOf
Determines whether, in TEXT/BUFFERHANDLE TEXTINSTRING/BUFFERHANDLE der TEXT/the elements of TEXTLIST TEXTSEARCH is/are contained and, if so, at which position(s) it/they are located. The position starts at 0. If the TEXT …
@IPHexDump2DecAdr
Converts V4 IP address(es) in HEX dump notation (TEXT/TEXTLIST TEXT1/TEXTLIST1) into IP address(es) in decimal dotted notation and returns them. HEXDump Notation: An IP address may be 7 or 8 characters long. If it has 7 …
@IsMember
Returns whether TEXT/TEXTLIST TEXT1/TEXTLIST1 is completely contained in TEXT/TEXTLIST TEXT2/TEXTLIST2. If TEXTLIST1 contains no elements, the result depends on whether TEXTLIST2 contains any elements: if TEXTLIST2 is em …
@IsNotMember
Returns 1 if TEXT/TEXTLIST TEXT1/TEXTLIST1 is not completely contained in TEXT/TEXTLIST TEXT2/TEXTLIST2; otherwise returns 0. If TEXTLIST1 contains no elements, the result depends on whether TEXTLIST2 contains any elemen …