Engine Help: Function
Filtered overview of the Engine Help documentation.
@GetNTComPortTimeouts
Only for the Engine under Windows! Current timeout settings for the COM port with OSCOMHANDLE OSCOMHANDLE1 query and return. With the exception of FN RDINT2 are with all specified values Timeouts specified, the from the …
@GetOIDComponents
Returns the components of the OID OID in TD RETTDDBID, TD RETTDNOTE, TD RETTDINSTANCETD and FLOAT RETFLOATINSTANCENUMBER. TD RETTDDBID is the database ID of the database in which the document was created. TD RETTDNOTE is …
@GetOpenDBs
Returns the number the currently from the Programm openedn databaseen.
@GetOpenNotes
Returns the number the currently from the opened documents by this program.
@GetOpenViews
Returns the number of the currently opened view by this program.
@GetOSComPortEvent
Returns which events have occurred since the last call with the same OSCOMHANDLE OSCOMHANDLE1. Events: Bit Decimal Hex EVENT 1 1 1 Char received 2 2 2 ReceiveTimeoutInterrupt (NOT SUPPORTED BY NT UND …
@GetOSComPortInfo
Returns the settings of the COMPORTS with the COSCOMPORTHANDLE COSCOMPORTHANDLE1. FNWRTO1: Write timeout (specified ?? normally 6000) Under NT this is the WriteTotalTimeoutConstant. See http://msdn2.microsoft.com/en-us/l …
@GetOSComPortInQueCount
Returns the number the bytes that are available at the time of the call of @GetOSComPortInQueCount to retrieval with @ReadOSComPort were available.
@GetOSComPortLineInfo
Returns the PortInfo to einem OSCOMPORT (Device). FNDATA1: Data Bits 7 or 8 FNPARITY1: Parity Bits (unklar) 0 =1 Bit 2 =2 Bit ??? FNSTOP1: Stop Bits (unklar) 0 =1 Bit 2 =2 Bit ??? FNTBREAK1 (TransBreak): Unklar ??? Examp …
@GetOSComPortOutQueCount
Returns the number the bytes that are available at the time of the call of @GetOSComPortOutQueCount to transmission (at the entfernte System) im OSCOM-Puffer anstehen.
@GetOSComPortSpeed
Returns the at the OSCOMPORT verwendete Baud-Rate.
@GetOSComPortStatus
Returns the Status of the OSCOM-PORT. Bit meaning 1 TX_WAITING_FOR_CTS 2 TX_WAITING_FOR_DSR 3 TX_WAITING_FOR_DCD 4 TX_WAITING_FOR_XON 5 TX …
@GetOSFileCreated
Returns the creation time of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD value for the cr …
@GetOSFileModified
Returns the time of the last modification of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD …
@GetOSPath
Returns the physical/local path (OSPATH) for the relative NOTESPATH/NOTESPATHLIST NOTESPATH1/NOTESPATHLIST1. Directory and database links are taken into account. If a NOTESPATHLIST is passed as the input parameter, error …
@GetPictureFileInfo
Returns information about the contents of an image file (an image within an image file). FILEHANDLE PICFILEHANDLE: FILEHANDLE to an image file opened in binary mode. FN FILETYPE: 1=TIFF File monochrom (T4 Compression in …
@GetPosAttachedFile
Returns the current position in the file attachment with the OBJECTFILEHANDLE OBJECTFILEHANDLE1 is returned.
@GetPosOSFile
Returns the current position in the OSFILE with the FILEHANDLE FILEHANDLE1.
@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 …
@GetRemoteDBPathByRID
On the server with the server name TEXT TEXTSERVERNAME the first DB with the replica ID RID DBRID is searched for and the Notes path (TEXT) to it is returned. The found DB can be opened with this Notes path. If no matchi …
@GetSchedListEntry
Returns the data for a specific entry FN POSITION2 of the SCHEDLIST SCHEDLIST1 is returned. In UID UID3 the UID of the document to which this entry refers is returned. In TDLIST TDLRANGE4 the time span of this entry is r …
@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.
@GetStartDocInfo
This @Function returns the DBHANDLE and the NOTEID of the document that caused this program to start. In DBHANDLE1 is the DBHANDLE of the database containing the triggering document is returned. In ID2 the NOTEID of the …
@GetSysInfo
Gets the system information specified by TEXT/TEXTLIST TEXT1/TEXTLIST1 and returns it as TEXT/TEXTLIST is returned. TEXT/TEXTLIST: OS Version number of the operating system LN Version number of the Lotus Notes server …
@GetSysMemInfo
Only for Engine under Windows! Returns operating-system-specific information about the memory usage of the Engine process. FN RetFNWorkingSet This parameter returns the current total memory usage (RAM) of the Engine proc …
@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.
@GetTickCount
Returns the milliseconds (ms) elapsed since system startup as FN is returned. The resolution depends on the system and is typically between 10 and 16 ms.
@GetUpdateCount
Returns the number of documents currently modified (and also created) by the program.
@GetUsedMem
Returns the size of the dynamic memory currently occupied by the program.
@GetVacantMem
Returns the size of the dynamic memory physically occupied by the program that is currently not being used.
@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 …
@GetVarByVPR
For the VPR (Variable Pointer Reference) of a variable, returns the content of the variable being referenced.
@GetVarFromVar
Returns the variable TEXT/RT/FN/TD TEXT1/RT1/FN1/TD1 ab Position FN FN2 for FN FN3 characters. In TEXT TYPE4 specifies the data type as which the return value is to be interpreted. RETTYPE4: A=TEXT B=Binär (RT) F=FLOAT N …
@GetVarVPR
When @GetVarVPR is called with one parameter, the VPR (Variable Pointer Reference) for the passed variable is returned. When called with two parameters, the variable with the name TEXT TEXT1 is searched for on the VStack …
@GetVarVPRList
Returns a VPRList for the variable(s) VAR1-VAR99 is returned. IMPORTANT: A VPRList is a list of handles to variables. This means that if the content of a variable specified in a VPRList is changed, this changed content i …
@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 …
@GetViewPosInfo
Returns the information for the VIEWPOS VIEWPOS is returned. The return value of the @Function returns the number of documents found (e.g. by the @Function @FindDocumentsByKey or @FindCategoryByName) . In the optional pa …
@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 …
@HexDumpToBin
@HexDumpToBin converts the hex stream dump in TEXT/BINBUFFER VAR1 into a binary buffer. Whitespace is ignored. Using TEXT TEXTRETTYPE2 it can be specified whether the returned binary data is returned as RT or as BINBUFFE …
@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.
@Hour
Returns the hours of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS is specified, this determines the return type. TEXT TEXTOPTIONS F=default (return data type = FLOAT/FLOATLIST) A=Retur …
@HttpExtractFields
The HTTP POST fields in TEXT TEXT1 are stored as Engine variables on the VStack TEXT VSTACKPATH2 stored. On success, TRUE returned, otherwise @ERROR.
@HTTPGet
Currently available for Windows only!!! Returns the HTML code of a web page as TEXT. In addition to TEXT SERVER1 and TEXT PAGE2, a port number FN PORT3 can optionally be specified. If omitted, port 80 is used by default. …
@HTTPSGet
Currently available for Windows only!!! Returns the HTML code of a web page as TEXT returned. In addition to TEXT SERVER1 und TEXT PAGE2 a port number FN/TEXT PORT3 can optionally be specified. If omitted, 443 (HTTPS) is …
@HugeTextList
Returns a variable of type HUGETEXTLIST with 0 elements.
@IDList
Returns a variable of type IDLIST with 0 elements.