Engine Help: R
Filtered overview of the Engine Help documentation.
@Rand
Currently available only under NT! Returns a pseudo-random number between 0 and 32767.
@ReadAttachedFile
Reads a record of length FN LENGTH3 from the file attachment identified by OBJECTFILEHANDLE OBJECTFILEHANDLE1. This record is returned as a variable of the data type specified by TEXT RETTYPE2. If TEXT/TEXTLIST TEXT3/TEX …
@ReadBuffer
Liest aus dem BINBUFFER with dem BUFFERHANDLE BUFFERHANDLE1 a record with length FN LENGTH3. This record is returned as a variable of the data type specified in TEXT RETTYPE2 . RETTYPE2: A=TEXT B=BINARY (derzeit as RICHT …
@ReadNTComPort
Only for Engine under Windows! Reads a value from the COM port identified by OSCOMHANDLE OSCOMHANDLE1 and returns it as the result of the @Function. The value to be read is expected to be of the type specified by TEXT RE …
@ReadOSComPort
RETTYPE2: A=TEXT B=BINARY (currently as RICHTEXT) N=NUMBER F=FLOAT L=FLOAT (converted long) D=FLOAT (converted DWORD) T=TIMEDATE STATUS4: 0=OK 1=Read Timeout expired 2=TEXT limit reached (only in TEXT mode) 32768=Error I …
@ReadOSFile
Reads a record of length FN LENGTH3 from the OS file identified by FILEHANDLE FILEHANDLE1. This record is returned as a variable of the data type specified in TEXT RETTYPE2. If TEXT/TEXTLIST TEXT3/TEXTLIST3 is specified, …
@ReadVarOSFile
Reads a variable from the OSFILE identified by FILEHANDLE FILEHANDLE1. The variable must have been written using @WriteVarOSFile, and is returned as the @Function result. The contents of a variable, including its name an …
@RecalculateNote
NOTEHANDLE NOTEHANDLE1 Document on which the recalculation should be executed. NOTEHANDLE NOTEHANDLE2 Form design document containing the formulas and fields. NF FLAGS3 0 Report errors 1 Continue on errors Return TEXTLIS …
@ReleaseClass
Releases the class(es) with the name(s) TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1. Return value: @Error -> An error occurred. TRUE -> All requested classes released. FALSE -> At least one of the classes could …
@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 …
@RemoteConsole
Executes on the remote console of TEXT SERVER1 das Kommando TEXT COMMAND2 . On success, a TEXT is returned as the result; otherwise @ERROR with the error text.
@RenameFolder
This @Function assigns to the folder in the DB with the DBHANDLE DBHANDLE1 and the VIEWHANDLE VIEWHANDLEFOLDER2 the name TEXT NEWFOLDERNAME3. ReturnWert: If the @Function was executed successfully, TRUE is returned; othe …
@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 …
@Replicate
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2. FNLIST FNLIST3 is a list of rights where the first element specifies the replication rights in the first database and the second …
@ReplicateWithFormula
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2, replicating only the documents thas match the Notes-compatible selection formula TEXT/TEXTLIST FORMULA3. If FORMULA3 a TEXTLIST i …
@ReplicateWithFormulaWithFieldException
Replicates the database with DBHANDLE DBHANDLE1 with the database with DBHANDLE DBHANDLE2, replicating only the documents thas match the Notes-compatible selection formula TEXT FORMULA3 entsprechen. FNLIST FNLIST4 is a l …
@ReplicateWithServer
The databases of the local Notes server are replicated with the remote Notes server TEXT SERVERNAME2 over the port TEXT PORTNAME1 by the Notes replicator, not by the Engine replicator. Using FN OPTIONS3, options can be s …
@RequestClass
Requests the class or classes with the name(s) TEXT/TEXTLIST TEXTCLASS1/TEXTLISTCLASSES1. Return value: @Error -> An error occurred. TRUE -> All requested classes were obtained. FALSE -> At least one of the r …
@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 …
@ResetVStack
Resets all variables on the VStack with the name TEXT NAME1 to the value in VAR1. If the @Function is called without the second parameter, the variables are set to the value/data type PV. Sub-VStacks located on the VStac …
@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 …
@RTAddButton
Appends a button labeled TEXT TEXT1 and containing the CNFORMULA CNFORMULA4 to the RichText field RT RT5. FNLIST STYLE2: 1. StyleDefinitionNumber 2. Font 3. Size 4. options 5. Color 1. StyleDefinitionNumber: Re …
@RTAddDocLink
Inserts a document link (DocLink) into the RichText field RT RTFIELD4. The link points to the document identified by NOTEHANDLE NOTEHANDLE3 in the database identified by DBHANDLE DBHANDLE1 and from the view identified by …
@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 …
@RTAddHotSpotTextDocLink
Adds a document link (DocLink) to the document in the database with DBHANDLE DBHANDLE1 from the view with VIEWHANDLE VIEWHANDLE2 and the NOTEHANDLE NOTEHANDLE3 in the rich-text field RT RTFIELD4 a. The parameter DOCLINKL …
@RTAddParagraph
Appends the RICHTEXT paragraph RT1, which is a complete RICHTEXT-portion, to the HRT (HUGERICHTEXT) variable HRT2. A RICHTEXT field consists of many individual paragraphs that describe the elements of the RICHTEXT field, …
@RTAddPictureFile
This function added to the HRT field HRT3 the content the image file with FH (FILEHANDLE) PICFILEHANDLE1. With Parameter FN FILETYPE2 the type of the image file must be specified. Return value: On success, the modified H …
@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 …
@RTDocFontsAddFont
Adds a new font with the name TEXT TEXT2 and the optional font family FN FNFONTFAMILY3 to a font field HRT HRT1, whose name is usually $Fonts. Return value: A FontHandle (NUMBER) for the new font, or @ERROR in case of an …
@RTDocFontsGet
Returns the available fonts from the font field HRT HRT1, whose name is usually $Fonts. RETTEXTLIST2 returns a TEXTLIST containing the names of the fonts included. RETNUMBERLIST3 returns a NUMBERLIST containing the corre …
@RTFetchInit
Initializes paragraph-by-paragraph retrieval of the RICHTEXT variable HRT HRT1. Return value: On success, a fetch handle for the HRT field HRT1 is returned; otherwise @ERROR is returned. This fetch handle must be passed …
@RTFetchParagraph
On each call, returns one paragraph of the RICHTEXT field HRT HRT1 in RT REGRTPARAGRAPH. This paragraph is returned as plain RT, not as HUGERICHTEXT. The fetch handle RTFH must initially have been initialized by @RTFetch …
@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 …
@RTInit
This function initializes an empty RichText value. FLOATLIST MARGINLIST1 can be used to set margins, and FLOATLIST TABLIST2 can be used to set tab stops for this field. MARGINLIST1: 1. Left margin in cm 2. Right margin i …
@RTInitEmpty
This function initializes an absolutely empty RichText value (0 bytes). IMPORTANT: The field flags; see @SetFieldFlags, of the return variable are set to 0. This is necessary because RichText fields should not have the S …
@RTSigTranslate
Returns, for a RICHTEXT paragraph signal (a type of identifier for a portion of RICHTEXT) a more meaningful TEXT value. In parameter FN FNMODE the type of the RICHTEXT field must be specified. By default, normal RICHTEXT …