Engine Help Category: Text
Filtered overview of the Engine Help documentation.
@JoinList
Implodes TEXT/TEXTLIST TEXTLIST1 taking into account FN/FNLIST LENGHTLIST2 and the separator string list TEXT/TEXTLIST SEPERATORLIST3 zu einem TEXT. FN/FNLIST LENGHTLIST2: Assigns a length to each element of TEXT/TEXTLIS …
@Left
Returns the left part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selected part can be FN COUNT2 characters or the text to the left of TEXT TEXT2. The search for TEXT2 is performed from left to right.
@LeftBack
Returns the left part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selected part can be all characters except for FN COUNT2 remaining characters, or the text to the left of TEXT TEXT2. The search for TEXT2 is performed from rig …
@Length
Returns the length of VAR VAR1, or the lengths of the individual elements of VARLIST VARLIST1.
@LogReport
Outputs the contents of the variable VAR1 to the API log and on the server console. With FN OPTIONS2 the detailed behavior of the @Function can be defined. FNLIST STYLE3 specifies the font, options, color and size of the …
@LowerCase
Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in lowercase.
@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 …
@Name
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 …
@Newline
Returns a line break that can be used in TEXT/TEXTLIST can be used.
@OpenQueue
Opens the message queue named TEXT TEXTQUEUENAME. On success, a queue handle is returned; otherwise @ERROR.
@Password
Generates from TEXT TEXTPASSWORD1 a hash, which is returned as TEXT . In case of an error, @Password @Error is returned. FN FNHASHTYPE2: 1 returns a hash like @Password in Notes. (Version compatible with Notes version >= …
@ProperCase
Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in proper case, i.e. the first letter is uppercase and the following letters are lowercase.
@PutQueue
Places the message TEXT TEXTMESSAGE with priority FN FNPRIORITY into the message queue with queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR. FN FNPRIORITY: 1 = Highest priority …
@ReleaseMutexSemaphore
Releases the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE . On success, @True is returned; otherwise @ERROR. A mutex semaphore can be owned (requested) by only one task at a time. (This is u …
@ReorgACLPrivileges
The empty elements of TEXTLIST PRIVNAMES2 are removed and returned in the parameter RETUSERPRIVS3 is returned. The corresponding privilege references in TEXTLIST USERPRIVS1 are adjusted and returned in the parameter RETP …
@ReorgList
This @Function rearranges the elements of a list and returns the newly ordered list. TEXTLIST/FNLIST/TDLIST LIST1 is the list whose elements are to be rearranged. FNLIST SEQUENCE1 specifies the new order. LIST1 and SEQUE …
@Repeat
Repeats the text in TEXT TEXT1 or in each element of TEXTLIST TEXTLIST1 until the count FN COUNT2 is reached, and optionally truncates the resulting texts after FN LENGTH3 characters.
@Replace
Replaces in TEXT/TEXTLIST TEXT1/TEXTLIST1 all elements TEXT/TEXTLIST TEXT2/TEXTLIST2 with TEXT/TEXTLIST TEXT3/TEXTLIST3. Thus, TEXT2/TEXTLIST2 specifies a list of text fragments to be replaced by text fragments from TEXT …
@ReplaceSubString
Replaces in TEXT/TEXTLIST TEXT1/TEXTLIST1 the strings specified in TEXT/TEXTLIST TEXT2/TEXTLIST2 with the corresponding element from TEXT/TEXTLIST TEXT3/TEXTLIST3. The optional parameter FN FNCMPMODE specifies the search …
@RequestMutexSemaphore
Requests and, on success, locks the mutex semaphore with the mutex semaphore handle (MSH) MUTEXSEMAPHOREHANDLE. On success, @True is returned; otherwise @ERROR. If FN FNTIMEOUT is specified, waiting for the mutex semapho …
@Reverse
Reverses the order of the characters in TEXT TEXT1 or in each element of TEXTLIST TEXTLIST1.
@Right
Returns the right part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selection can be based on FN COUNT2 characters or on the text to the right of TEXT TEXT2. The search for TEXT2 is performed from left to right.
@RightBack
Returns the right part of TEXT/TEXTLIST TEXT1/TEXTLIST1. The selection can include all characters except FN COUNT2 remaining characters, or the text to the right of TEXT TEXT2. The search for TEXT2 is performed from righ …
@RTAddFileIcon
Appends a file icon in OS/2 style to the RichText field RT RT4. TEXT1: Name of the file attachment used for display and for reference within the Notes document. This name must be unique. TEXT2: Original name of the file …
@RTAddPopUpEnd
Adds a logical closing pop-up bracket to the RichText field RT3. See @RtAddPopUpStart.
@RTAddPopUpStart
Appends TEXT TEXT1 or CNFORMULA CNFORMULA1 as a pop-up with the pop-up flags FN FLAGS2 to the end of the RichText value RT RT3. This should be regarded as a logical opening bracket. Everything appended to the RichText fi …
@RTAddText
Appends the TEXT TEXT1 in the font/style NUMBERLIST STYLE2 to the end of the Richtext RT RT3. FN STYLE2: 1. StyleDefinitionNumber 2. Font 3. Size 4. options 5. Color 1. StyleDefinitionNumber: Reserved 2. Font: …
@RTAttachmentIconChange
The variable RT RT1 is searched for file icons that refer to the file attachments specified in TEXT/TEXTLIST TEXT1/TEXTLIST1. Any file icons found are renamed to the names specified in TEXT/TEXTLIST TEXT2/TEXTLIST2, corr …
@RTFetchText
Returns the text portion of HRT HRT1 as TEXT, portion by portion. At the beginning, NUMBER RETNUMBER2 must contain 0. NUMBER RETNUMBER2 specifies the SEGMENTPOINTER. If there is more text to retrieve, @RTFetchText return …
@SetEnvironment
Sets the environment variable TEXT TEXT1 to the value TEXT TEXT2.
@SetFieldFlags
Sets the field flags FN2 for Notes in a variable. If a variable is not explicitly assigned flags using @SetFieldFlags, the default values are assumed. However, if flags have been assigned, those flags always apply. Field …
@SetListElement
Replaces the element at FN POSITION2 of FN/FNLIST/TEXT/TEXTLIST/TD/TDLIST/IDLIST/HUGETEXTLIST FN1/FNLIST1/TEXT1/TEXTLIST1/TD1/TDLIST1/IDLIST1/HUGETEXTLIST1 with FN3/TEXT3/TD3 and returns the new list as the result. In th …
@SetLogDocField
Sets a field named TEXT TEXT1 and with the content TEXT/TEXTLIST/FN/FNLIST/TD/TDLIST TEXT2/TEXTLIST2/FN2/FNLIST2/TD2/TDLIST2 in the current APILog document.
@SetProfileField
Sets the content of the profile field named TEXT TEXTFIELDNAME, for the user named TEXT TEXTUSERNAME (may also be ""), using the profile form named TEXT TEXTPROFILEFORMNAME from the database identified by DBHANDLE DBHAND …
@SetVar
Sets the value of the variable(s) named TEXT/TEXTLIST NAME1 to the value VAR3. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be specified as …
@SetVarFieldFlags
Sets the Notes field flags for the field specified in TEXT NAME1 to the value FN FN1. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be specif …
@SetVarWithFieldFlags
Sets the value of the variable(s) with the name(s) TEXT/TEXTLIST NAME1 to the value VAR3. If the variable belongs to a group, for example a document, the group name, for example the NOTEHANDLE of the document, must be sp …
@ShiftList
Shifts the FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1 in the direction FN DIRECTION3, sets the vacated position to FN/TEXT/TD FN2/TEXT2/TD2 and removes the element at the other end of the l …
@SortList
Sorts the TEXT/TEXTLIST TEXT1/TEXTLIST1 and returns this sorted list. Optionally, a reorganization list NUMBERLIST SEQUENCE1 can be returned. It can be used with @ReorgList to put other lists into the same order into whi …
@Soundex
Returns a numeric code for TEXT/TEXTLIST TEXT1/TEXTLIST1 that enables a homophonic (similar-sounding) comparison. It is mainly used in the address book.
@StringExceptions
The string exceptions (see the StringExceptions texts) that the compiler applies to static texts are also applied by @StringExceptions to the passed TEXT TEXT1. Example @StringExceptions(TEXT1): Text:=@StringExceptions(" …
@Subset
Returns a sublist of FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/IDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/IDLIST1. If FN COUNT2 is positive, the first COUNT2 elements are returned; if COUNT2 is negative, the last COUNT2 elem …
@Text
Converts FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/UIDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/UIDLIST1 into TEXT/TEXTLIST and returns it. For UIDLIST, the return data type is always TEXTLIST. NOTE: @Text in the Engine diffe …
@TextToDigits
Converts the ASCII characters of TEXT/TEXTLIST TEXT1/TEXTLIST1 into the corresponding ASCII-CHAR values and returns them in the form of TEXT/TEXTLIST. OPTIONS1 specifies the numeral system in which the ASCII-CHAR values …
@TextToNumber
Converts TEXT/TEXTLIST TEXT1/TEXTLIST1 into FLOAT/FLOATLIST and returns it. FN MODE2 can be used to specify the conversion mode; if it is omitted, zero is assumed. NOTE: @TextToNumber in the Engine differs slightly from …
@TextToTime
Converts the text TEXT/TEXTLIST TEXT1/TEXTLIST1 into a time-date value TD/TDLIST. TEXT TEXTOPTIONS: If "*" is specified here, the texts are expected in TD hex dump format, for example "C1255DF0:004B73DC" (corresponding t …
@TextToTimePair
Converts the text TEXT TEXT1 into a time-date pair value TDLIST. Use "-" as the separator for the time-date pair. Do not use "/" or "-" as separators between individual date components; use a period instead.
@TextToUID
Converts the text TEXT/TEXTLIST TEXT1/TEXTLIST1 into a UIDList. TEXT1 or the individual elements of TEXTLIST1 must have a length of 32 characters.