Engine Help Category: TimeDate
Filtered overview of the Engine Help documentation.
@Accessed
Returns the time of the last access to the document with the NOTEHANDLE NOTEHANDLE1 back.
@Adjust
Changes the individual components of the time/date value TD/TDLIST TD1/TDLIST1 by the values specified in FN YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 . YEAR2/MONTH3/DAY4/HOUR5/MINUTE6/SECOND7 is added to year/month/day/ho …
@AllDay
Returns the time/date value (TD) for any time. A comparison with any time is always TRUE.
@AnyAllDay
Returns the time/date value (TD) for any date and time. A comparison with any other time/date value is always TRUE.
@AnyDay
Returns the time/date value (TD) for any date. A comparison with any other date is always TRUE.
@BuildList
Creates a list with FN COUNT2 identical elements FN/TEXT/TD/ID FN1/TEXT1/TD1/ID1.
@BuildNamedDocKeyLists
This @Function creates two corresponding lists (HUGETEXT RETHTL and IDLIST RETIDL). In the list HUGETEXT RETHTL the contents of the fields are returned sorted alphabetically, from the documents specified by the selection …
@CloseQueue
Closes the message queue with the queue handle VSPECQUEUEHANDLE QUEUEHANDLE. On success, TRUE is returned; otherwise @ERROR.
@Created
Returns the time/date value (TD) of the creation of the document with the NOTEHANDLE NOTEHANDLE1.
@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 …
@Date
Returns the date part of TD/TDLIST TD1/TDLIST1.
@Day
Returns the day of the month of TD/TDLIST TD1/TDLIST1. If the @function is called with the parameter TEXTOPTIONS is called, this determines the return type. F=Wie ohne TEXTOPTIONS (return data type = FLOAT/FLOATLIST) A=r …
@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.
@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 …
@GetDBActivity
Retrieves the user-activity log of the database with DBHANDLE1. The @Function result is 1 if there is no error, or @ERROR. The last four arguments of the @Function are return parameters: In RETTDLIST2 the times are retur …
@GetDBCurrentAccess
For the DB with the DBHANDLE DBHANDLE1 the current access level at the time of the call and, optionally, the currently effective flags (NUMBER NRETFLAGS) are returned. In case of an error, @Error is returned. USERLEVELS: …
@GetDBLaunchOptions
Returns the launch DB options of the DB with the DBHANDLE DBHANDLE1 as a bit vector (FN). In TEXTLIST TEXTLIST1 the names of the navigators or the view are returned. In RID RID1 the RID of the DB to which the doclink poi …
@GetDBModified
Returns when the database with the DBHANDLE DBHANDLE1 was last modified. The return value (TD) contains the last modification of a data document and TD TD1 contains the last modification of a non-data document.
@GetDBOptions
Returns the DB options of the DB with the DBHANDLE DBHANDLE1 as a bit vector (FN). In FN FNEXTOPTIONS the extended options of the DB are returned. FNEXTOPTIONS: BIT DEC HEX MEANING if set 01 000001 00001 Allo …
@GetDBQuota
Returns the DB quota of the DB with the DBHANDLE DBHANDLE1 as FLOATLIST with 4 elements. Element No. Meaning 1 Maxium size in kB of the database 2 Actual size in kB of the database 3 Quota in kB of the database 4 …
@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.
@GetLinkListProperties
Returns the properties of the document link at the position FN POSITION2 from the VSPECLINKLIST DOCLINKLIST1. TD RETTDRID3 is the replica ID of the DB on the documents-Link verweist. (Steht hier @AnyAllDay verweist er in …
@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 …
@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 …
@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 …
@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 …
@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 …
@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 …
@Minute
Returns the minutes of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = …
@Modified
Returns the time of the last modification of the document with the NOTEHANDLE NOTEHANDLE1.
@Month
Returns the month of TD/TDLIST TD1/TDLIST1. If the @Function is called with the parameter TEXTOPTIONS the return data-type is as follows. F=default TEXTOPTIONS (return data-type = FLOAT/FLOATLIST) A=return data-type = TE …
@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 …
@Now
Returns the current date/time value. If the @Function with the optional parameter FN FN = 1 is called, the system time is returned instead of the Domino server time (these may differ!).
@OpenQueue
Opens the message queue named TEXT TEXTQUEUENAME. On success, a queue handle is returned; otherwise @ERROR.
@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 …
@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 …
@Second
Returns the seconds of TD/TDLIST TD1/TDLIST1 value. If the @Function is called with the parameter TEXTOPTIONS , it determines the return type. F=like without specifying TEXTOPTIONS (return data type = FLOAT/FLOATLIST) A= …
@SetDBLaunchOptions
Sets the database launch options of the database identified by DBHANDLE DBHANDLE1. FN FNOPTIONS specifies the database launch options of the database. TEXTLIST TEXTLIST1 specifies the names of the navigators or the view. …
@SetDBOptions
Sets the database options specified in FN FN2 in the database identified by DBHANDLE DBHANDLE1. If FN FNEXTOPTIONS is specified, the extended database options are also set; otherwise they remain unchanged. On success, FN …
@SetDBQuota
Sets the database quota of the database identified by DBHANDLE DBHANDLE1 to the values specified in FNLIST FNLISTQUOTA2. Element No. Meaning 1 Maximum size of the database in kB 2 Actual size of the database in kB …
@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 …