|
Use
your current version of Help-Database for actual and detailed references.
@AttachmentModifiedTimes
Returns a datetime that displays
the date on which the file attachment associated with the current
document was last modified. If the document contains more than one file
attachment, returns the modification dates in a datetime list.
<<
@BusinessDays
Returns the number of business days
in one or more date ranges.
@BusinessDays( startDates ; endDates ; daysToExclude ;datesToExclude )
@BusinessDays([01/01/2001];
[12/31/2001]; 1 : 7;[11/23/2001] : [12/25/2001]))
<<
@CheckFormulaSyntax
Checks a block of
commented out formula language code for errors.
Enclose the formula code in braces ({}) to comment out the code.
@CheckFormulaSyntax(formulaText)
Returns "1" if the formula has no
errors,
else returns the text list "errorMessage" : "errorLine"
: "errorColumn" : "errorOffset" : "errorLength"
: "errorText"
<<
@Compare
Compares the alphabetic order of the elements in two lists pair-wise.
@Compare( textlist ; textlist ; [ options ] )
example:
list := "Boston" : "Tokyo" : "Moscow" : "N" : "n";
@text(@compare(list; "N"; [CaseInsensitive]));
Return value
0 if the elements in the two lists are equal
-1 if the element in the first list is less than the element in the second list.
1 if the element in the first list is greater than the element in the second
list.
<<
@ConfigFile
Returns the file path for the initialization file for Lotus Notes (notes.ini).
Example: C:\Lotus\Notes\notes.ini
<<
@Count
@Count( list )
Calculates the number of text, number, or timedate values in a list.
This function always returns a number to indicate the number of entries in the list.
<<
@DocLock
@DocLock ( [ options ] )
Locks, unlocks, returns the locked status of the current document,
or indicates if a database has document locking enabled.
options: [LOCK] [UNLOCK] [STATUS] [LOCKINGENABLED]
<<
@DocOmittedLength
Returns the approximate number of bytes a truncated document lost during replication. The bytes are the total number of bytes per attachment, OLE object, large rich text field, or non-summary items that were too large, according to the replication settings for the database, to be replicated.
Example: when used as a column formula, returns the total size of the document:
@DocLength + @DocOmittedLength
<<
@EditUserECL
Displays the
"Workstation Security: Execution Control List" dialog
box,
which allows you to change your personal ECL for the current
workstation.
<<
@Eval
@Eval(textExpressions)
At run-time, compiles and runs each element in a text expression as a formula.
Returns the result of the last formula expression in the list
or an error if an error is generated by any of the formula expressions in the list.
Example: input := {FIELD comment := @Prompt([OKCANCELEDIT];"Input";"Input a value"; "Default");};
@Eval(input);
<<
@FileDir
@FileDir( pathname)
Returns the directory portion of a path name, that is, the path name minus the file name.
<<
@FloatEq
@FloatEq( number ; number ; confidenceRange )
Compares two numbers for equality within a confidence range.
confidenceRange: The amount within which the numbers must be equal. Defaults to 0.0001.
<<
@For
@For( initialize ; condition ; increment ; statement ; ... )
Loop on statements
<<
@GetAddressBooks
@GetAddressBooks( [options ] )
Returns a list of the address books associated with a client (if the current database is local) or server.
options:
Keyword. The following keywords are optional arguments for this @function: [TITLES] [FIRSTONLY]
<<
@GetCurrentTimeZone
Returns the current operating system's time zone settings in canonical time zone format.
<<
@GetField
Returns the value of a specified field.
@GetField ( fieldName )
see also @GetDocField(
documentUNID ; fieldName )
<<
@GetFocusTable
Returns the name, current row, or current column of the table that is in focus.
@GetFocusTable ( [ tableInfoRequest ] )
tableInfoRequest keywords:
[CELLROW] [CELLCOLUMN] [TABLENAME]
<<
@GetHTTPHeader
In a Web application, returns the value of an HTTP header from the browser client request being processed by the server.
@GetHTTPHeader( requestHeader )
The name of a request-header field, for example, "From," "Host," or "User-Agent."
example:
User-Agent: Mozilla 4.0 (X; I; Linux-2.0.35i586)
Host: mylinuxbox.ibm.com
<<
@GetViewInfo
Returns a view attribute
@GetViewInfo ( [ attribute ] ; column )
attributes:
Keyword. Must be enclosed in brackets
[CalendarViewFormat] [ColumnValue] [IsCalViewTimeSlotOn]
examples:
@GetViewInfo([IsCalViewTimeSlotOn]) = @True |
@GetViewInfo([CalendarFormat]) = 30
@GetViewInfo([ColumnValue]; 4) = "Task"
<<
@HardDeleteDocument
In an agent that runs a formula, @HardDeleteDocument permanently removes the document currently being processed from the database if the database has soft deletions enabled.
<<
@HashPassword
Encodes a string
@HashPassword creates a more secure password than the @Password function does.
@HashPassword(string)
<<
@Hour
Returns the number of the hour in the specified timedate.
@Hour( timeDateValue )
@Hour([9:30]) returns 9
<<
@IfError
Returns a null string ("") or the value of an alternative statement if a statement returns an error.
@IfError( statement1 ; statement2 )
<<
@IsNull
Tests for a null value. Returns true only if a value is a single text value that is null, otherwise it returns false, returns false if the value is an error.
@IsNull( value )
Example: @If(@IsNull(OriginalList); @Nothing; ....
<<
@IsVirtualizedDirectory
Indicates whether virtualized directories are enabled for the current server.
<<
@LDAPServer
Returns the URL and port number of the LDAP listener in the current domain. Notes looks for this information in several places, following this search sequence:
<<
@Nothing
Use with an @Transform formula.
Returns no list element (reducing the return list by one element). Not valid in any other context.
<<
@OrgDir
In a Service Provider (xSP) environment, returns the name of the subdirectory for the company with which the currently authenticated user is registered. Lotus Notes/Domino retrieves this information from the organization's certifier document.
Example:
@Command([FileOpenDatabase];@ServerName + ":" + @OrgDir + "\\" + @DbName[2])
<<
@ReplicaID
Returns the replica ID of the current database.
<<
@ServerAccess
Checks if a specified user has a specified administrative access level to a server.
@ServerAccess( [ access ] ; userName ; serverName )
access example:
[ACCESS] [CREATEDATABASE] [CREATEREPLICA] [CREATETEMPLATE][VIEWONLYACCESS] + more...
<<
@ServerName
Returns the name of the server containing the current database.
When the database is local, returns the user name
<<
@SetHTTPHeader
In a Web application, sets the value of HTTP headers in the response being generated by the server for the browser client.
@SetHTTPHeader( responseHeader ; value )
example: @SetHTTPHeader("Set-Cookie"; "SHOP_CART_ID=4646")
<<
@SetViewInfo
In Standard Outline views, filters a view to display only documents from a specified category. In Calendar views, filters a view to display only document that contain a specified string in a specified column.
In a Standard Outline view:
@SetViewInfo( [SETVIEWFILTER] ; filterString ; columnName ; isCategory )
In a Calendar view:
@SetViewInfo( [SETVIEWFILTER] ; filterString ; columnName ; exactMatch )
<<
@Sort
Sorts a list.
@Sort( list ; [ order ]; customSortExpression )
list: Text, number, or time-date list.
order:[ACCENTSENSITIVE][ACCENTINSENSITIVE][ASCENDING] + more...
<<
@StatusBar
Writes a message or messages to the status bar.
@StatusBar( statusBarText ) @StatusBar("Hello world for example")
<<
@ThisName
Returns the name of the current field.
<<
@ThisValue
Returns the name of the current field.
<<
@TimeMerge
Builds a time-date value from separate date, time, and time zone values.
@TimeMerge( date; time ; timeZone )
<<
@TimeToTextInZone
Converts a time-date value to a text string, incorporating time zone information.
@TimeToTextInZone( timeDate ; timeZone ; formatString )
formatString: D0 Y, M, D
D2 Month and day, D3 Month and year and more....
<<
@TimeZoneToText
Converts a canonical time zone value to a text string.
@TimeZoneToText( timeZone ; formatString )
formatString: S Short time zone string, eg: "GMT-08:00"
formatString: A Alias for local time zone.
<<
@ToTime
Converts a value with a data type of text or time to a date-time value.
@ToTime(value)
example: @ToTime("08/29/01")
<<
@Transform
Applies a formula to each element of a list and returns the results in a list.
@Transform( list ; variableName ; formula )
example: @Transform(OriginalList; "x"; @If(x >= 0; @Sqrt(x); -@Sqrt(@Abs(x))))
<<
@UpdateFormulaContext
Updates the context of a formula to the Notes client window currently being accessed by the code. For example, if the code accesses a new form called "Response" by using @Command([Compose]:"Response", @UpdateFormulaContext switches the context of the formula to this new form. Any subsequent functions in the code execute in the context of the Response document, not the current document.
This function is only valid in the Notes client
<<
@URLDecode
Decodes a URL string into regular text.
@URLDecode( decodeType ; token )
decodeType: "Domino" or "Platform"
Example: It returns "Employee/My Database"
if the token field contains "Employee%2FMy%20Database.nsf."
<<
@URLEncode
Encodes a string into a URL-safe format.
@URLEncode( encodingFormat ; token )
<<
@UrlQueryString
In a Web application, returns the current URL command and parameters,
or the value of one of the parameters.
@UrlQueryString( parameterName )
example: http://www.acme.com/db.nsf?OpenForm&ID=986574&Category=Golf
returns: "OpenForm":"ID=986574":"Category=Golf"
<<
@VerifyPassword
Compares two passwords.
@VerifyPassword( password ; password )
<<
@WebDbName
Returns the name of the current database encoded for URL inclusion.
example: @URLOpen(@WebDbName + "/View+A?OpenView")
<<
@While
Executes one or more statements iteratively while a condition remains true. Checks the condition before executing the statements.
@While( condition ; statement ; ... )
<<
|