EN 843 documents

Engine Help: Function

Filtered overview of the Engine Help documentation.

← Back to Engine Help overview

581 documents found

@Today

Function Version 1.90

Returns the current date.

@Tomorrow

Function Version 1.90

Returns the date of the next day.

@Trace

Function Version 1.90

Turns trace mode on (1) or off (0) according to FN STATE1. This determines whether all errors (1) or only severe errors (0) are written to the log file.

@TransferNoteHandle

Function Version 4.50

Maps the external NOTEHANDLE NOTEHANDLE1 to NOTEHANDLE NOTEHANDLE2 and transfers it into the current context. NOTEHANDLE NOTEHANDLE2 is returned. @TransferNoteHandle is primarily intended for GLOBAL DEFFN functions in wh …

@Translate

Function Version 10.04

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted as defined by FN FNCHARSETS. This is the direct invocation of the function in the Domino API. FN FNCHARSETS: OS_TRANSLATE_NATIVE_TO_LMBCS    0   /* Translate platform-specific t …

@TranslateASCIIToEBCDIC

Function Version 4.50

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the EBCDIC character set.

@TranslateASCIIToISO88591

Function Version 5.00

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the ISO88591 character set.

@TranslateASCIIToWinANSI

Function Version 5.00

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ASCII character set to the WinANSI character set.

@TranslateEBCDICToASCII

Function Version 5.00

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the EBCDIC character set to the ASCII character set.

@TranslateISO88591ToASCII

Function Version 5.00

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the ISO88591 character set to the ASCII character set.

@TranslateURLEncodingToUTF8

Function Version 10.06

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from URL-encoding representation to the UTF8 character set.

@TranslateUTF8ToUrlEncoding

Function Version 10.06

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the UTF8 character set to URL-encoding representation. The optional parameter FN FNOPTIONS1 can be used to control the conversion: FN FNOPTIONS1: 0 A + character is convert …

@TranslateWinANSIToASCII

Function Version 5.00

TEXT/TEXTLIST TEXT1/TEXTLIST1 is converted from the WinANSI character set to the ASCII character set.

@Trim

Function Version 1.90

Removes leading, trailing, and redundant spaces from TEXT/TEXTLIST TEXT1/TEXTLIST1 and returns TEXT/TEXTLIST. Empty list elements are not removed. NOTE: @Trim in the Engine differs slightly from the Notes @Function @Trim …

@TrimLeftAndRightQuote

Function Version 4.50

Removes an existing quotation mark at the beginning or end of TEXT TEXT1. For TEXTLIST TEXTLIST1, this is performed for each element. Quotation marks inside TEXT TEXT1 or inside the elements of TEXTLIST TEXTLIST1 are pre …

@TrimList

Function Version 1.90

Eliminates empty list elements from TEXTLIST TEXTLIST1 and returns a TEXTLIST. When called with TEXT TEXT1, the TEXT is returned unchanged. Note: A TEXTLIST consisting of n empty list elements (@BuildList("";n)) becomes …

@Unavailable

Function Version 1.90

Deletes a variable in a document or a VARGROUP by returning the value UV Unavailable when it is used as the right-hand value of an assignment.

@Undefine

Function Version 4.50

Deletes a defined "term" that can be used for conditional compilation. In contrast to the keyword UNDEFINE, @Undefine takes effect at runtime, and only if this @Undefine is executed. TEXT1 must not contain spaces (" ") o …

@UNIDList

Function Version 2.10

Returns a variable of type UNIDLIST with 0 elements.

@Unique

Function Version 1.90

Eliminates duplicate entries from TEXTLIST/FLOATLIST/IDLIST TEXTLIST1/FLOATLIST1/IDLIST1 and returns this cleaned-up list. For TEXT/FLOAT TEXT1/FLOAT1, this value is returned unchanged. For IDLIST, the list must first be …

@UniqueEven

Function Version 4.60

Eliminates entries in TEXTLIST TEXTLIST1 that occur an odd number of times and returns this cleaned-up list. The TEXTLIST TEXTLIST1 must first have been sorted with @SortList. For TEXT TEXT1, a NULLTEXTLIST is returned.

@UniqueUnEven

Function Version 4.60

Eliminates entries in TEXTLIST TEXTLIST1 that occur an even number of times and returns this cleaned-up list. The TEXTLIST TEXTLIST1 must first have been sorted with @SortList. For TEXT TEXT1, this value is returned unch …

@UpdateNote

Function Version 1.90

Updates the document identified by NOTEHANDLE NOTEHANDLE1 and returns the NOTEHANDLE. FN MODE2 can be used to specify more detailed behavior. MODE2: 0 = Do not save changes. 1 = Save changes. 2 = Save changes without cha …

@UpdateView

Function Version 1.90

Updates the view identified by VIEWHANDLE VIEWHANDLE1 and returns VIEWHANDLE1.

@UpperCase

Function Version 1.90

Returns TEXT/TEXTLIST TEXT1/TEXTLIST1 in uppercase. Beipiel: @UpperCase(TEXT1) TEXT1:="HeLLo woRLd !!!"; @UpperCase(TEXT1); returns "HELLO WORLD !!!"

@VerifyNoteSignature

Function Version 4.50

Checks whether the document identified by NOTEHANDLE NOTEHANDLE1 is signed and whether the signature is still valid. If a signature could be positively confirmed (certified key in the address book), TRUE returned, otherw …

@VerifyPassword

Function Version 10.01

Checks whether the password TEXT TEXTPASSWORD1 matches the hash TEXT TEXTHASH2; see @Password. On success, TRUE is returned; otherwise FALSE is returned.

@ViewPos

Function Version 10.02

Returns the information for the VIEWPOS VIEWPOS . The return value of the @Function returns the number of documents found, for example by the @Function @FindDocumentsByKey. The optional parameter FNLIST FNPOSLIST returns …

@WaitNTComPortEvent

Function Version 4.00

Waits for a specific event that occurs on the COM port identified by OSCOMHANDLE OSCOMHANDLE1. If FN MASK2 is not specified, the current setting applies. Otherwise, the valid event mask is set to the passed value before …

@Weekday

Function Version 1.90

Returns the weekday of TD/TDLIST TD1/TDLIST1 as a NUMBER between 1 (Sunday) and 7 (Saturday).

@Word

Function Version 1.90

Returns the word at position FN/FNLIST POSITION3 from TEXT/TEXTLIST TEXT1/TEXTLIST1, using TEXT/TEXTLIST TEXT2/TEXTLIST2 to define a delimiter text that separates the words. For both TEXTLIST2 and POSITION3 in the list c …

@WriteACL

Function Version 4.50

This @Function writes an in-memory copy of the ACL to the database specified by the DBHANDLE DBHANDLE. When the VSPECHACL handle is no longer required, it must be released using @ReleaseACL. This @Function does not relea …

@WriteBuffer

Function Version 5.00

Writes the contents of a variable from the current position; see @GetPosBuffer/@SetPosBuffer, to the BINBUFFER identified by BUFFERHANDLE BUFFERHANDLE1. Currently, the following data types are supported for VAR2: TEXT TE …

@WriteNTComPort

Function Version 4.00

Outputs the contents of a variable of type TEXT, FN, or TD to a previously opened COM port. Only for Engine under Windows!

@WriteOSComPort

Function Version 3.00

Example: @WriteOSComPort(OSCOMHANDLE1;TEXT2) OSCOMHANDLE1:=@OpenOSComPort("COM1"); TEXT2:="TestText"; @WriteOSComPort(OSCOMHANDLE1;TEXT2); FILEHANDLE1:=@CloseOSComPort(OSCOMHANDLE1); Opens a COM port, writes "TestText" t …

@WriteOSFile

Function Version 1.91

Writes the contents of TEXT/FN/TD TEXT2/FN2/TD2 to the OSFILE identified by FILEHANDLE FILEHANDLE1. If the operation was successful, 1 (NUMBER) is returned. The optional parameter TEXT TEXTWRITETYPE3 specifies the write …

@WriteVarOSFile

Function Version 5.00

Writes the complete representation of the variable VAR, including all associated metadata, in binary form to the OSFILE identified by the FILEHANDLE FILEHANDLE1. If the operation is successful, 1 (NUMBER) is returned. A …

@XMLAddChild

Function Version 10.01

This @Function creates a new direct child XML element below an existing XML node. Optionally, content can be assigned to the new element directly. In addition, a namespace URI can be specified. In this case, the namespac …

@XMLCreate

Function Version 10.01

This @Function creates a new, empty XML document. The created XML document uses XML version 1.0. The supplied flags are stored in the created VSPECHXMLDOC (XMLD) handle and are inherited by XML handles derived from it la …

@XMLCreateRoot

Function Version 10.01

This @Function creates the root element of an XML document previously created with @XMLCreate. Optionally, one or more namespace prefixes and their corresponding namespace URIs can also be specified. The first specified …

@XMLGetAllContent

Function Version 10.01

This @Function retrieves the complete text content of an XML node, including the content of all child elements. The content is converted to the desired character set according to the output flags set for the XML handle. …

@XMLGetAttribute

Function Version 10.01

This @Function retrieves the value of a specified attribute of an XML node. The attribute is searched by name. Optionally, a namespace can also be specified. In this case, both the attribute name and the namespace URI mu …

@XMLGetAttributes

Function Version 10.01

This @Function retrieves the attributes of an XML node. The attribute names are returned as a text list. Optionally, the corresponding attribute values, namespace URIs, and namespace prefixes can also be returned in addi …

@XMLGetChildByName

Function Version 10.01

This @Function retrieves the first direct child XML element with a specified name. Optionally, a namespace can also be specified. In this case, both the element name and the namespace URI must match. The search parameter …

@XMLGetContent

Function Version 10.01

This @Function retrieves the direct text content of an XML node. Only directly contained text and CDATA nodes are included. Content from child XML elements is not included. The content is converted to the desired charact …

@XMLGetFirstChild

Function Version 10.01

This @Function retrieves the first direct child XML element of an XML node. Only XML elements are considered. Other node types, such as text, comment, or CDATA nodes, are skipped. The flags inherited from the supplied XM …

@XMLGetName

Function Version 10.01

This @Function retrieves the name of an XML node. The supplied handle must contain a valid VSPECHXMLNODE (XMLN) handle. The name of the node is returned as text. If character set conversion is enabled for the XML handle, …

@XMLGetNamespace

Function Version 10.01

The supplied handle must contain a valid VSPECHXMLNODE (XMLN) handle. If a namespace is associated with the node, its namespace URI is returned as text. If character set conversion is enabled for the XML handle, the retu …

@XMLGetNextSibling

Function Version 10.01

This @Function retrieves the next XML sibling element of an XML node. Only XML elements are considered. Other node types, such as text, comment, or CDATA nodes, are skipped. The flags inherited from the supplied XML node …