Basic product usage information and programming language reference information.
Welcome to the LotusScript® Language section of Domino® Designer Help.
This chapter describes the use of statements, built-in functions, subs, data types, and directives in the LotusScript® language.
Returns the square root of a number.
Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
Welcome to the Application Design section of Domino® Designer Help.
Welcome to the Application Management section of Domino® Designer Help.
Domino Query Language (DQL) is a facility running in Domino core allowing for a terse shorthand syntax for finding documents according to a wide variety of complexity of terms. It leverages existing design elements without the need to write detailed code to access them.
Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
This section documents the formula language.
This chapter introduces LotusScript® and describes, in general terms, how to use the script editor to write and modify scripts, how to compile scripts, and how to use the debugger to locate problems in the logic of your applications.
This chapter describes the rules for writing the basic elements of a script in the LotusScript® language.
This chapter provides information about LotusScript® constants and variables and the data types of the values that they can represent.
This chapter describes the set of LotusScript® operators, how they may be combined with operands to form expressions, and how those expressions are evaluated.
This chapter describes file handling in the LotusScript® language.
This chapter describes error processing in the LotusScript® language.
This chapter describes two kinds of custom data structures that you can define in LotusScript®. Each can hold data of different types in a single data structure.
The flow of execution of a script generally follows the sequence of statements in the script. This chapter describes the behavior of particular statements that alter the flow of execution.
This chapter describes how to use multiple threads and synchronization to manage HTTP agents with Domino®.
This chapter discusses the role that LotusScript® plays with IBM® products, your operating environment, other programs, and interactive user applications.
Listed here are the reference topics from A to D.
Listed here are the reference topics from E to H.
Listed here are the reference topics from I to L.
Listed here are the reference topics from M to P.
Listed here are the reference topics from Q to T.
Listed here are the reference topics from U to Z.
Returns the absolute value of a numeric expression.
Returns the arccosine, in radians, of a number between -1 and 1, inclusive.
Makes a program window the active window.
Appends an array or scalar value to an array and returns the result as an array.
Searches an array of strings for the value given. If the value is found within the array, the array index of that value is returned.
Performs a search and replace routine for multiple values within an array.
Removes duplicate elements from an Array.
Returns the locale-sensitive ASCII character code for the first character in a string.
Returns the arcsine, in radians, of a number between -1 and 1, inclusive.
Returns the arctangent, in radians, of a number.
Returns the polar coordinate angle, in radians, of a point in the Cartesian plane.
Generates a tone on the computer.
Returns the binary representation of a number as a string.
Specifies a variable that contains a True (-1) or False (0) value.
For applications developed with some IBM® products, such as 1-2-3®, you can use names in brackets rather than object reference variables to identify IBM software objects. To determine whether your IBM software supports this notation, see the product documentation.
Specifies a variable that contains a single, one-byte unsigned number.
Calls a LotusScript® sub or function.
Returns an expression converted to the Boolean data type.
Returns an expression converted to the Byte data type.
Returns a value converted to the Currency data type.
Converts a numeric value or string value to a date/time value.
Returns a value converted to the Double data type.
Sets the current directory.
Sets the current drive.
Returns the character represented by a value interpreted as a locale-sensitive character code.
Returns a value converted to the Integer data type.
Defines a class with its member variables and procedures.
Returns a value converted to the Long data type.
Closes one or more open files, after writing all internally buffered data to the files.
Acquires the lock specified by ID.
Returns the number of agents waiting for the the specified lock, plus 1.
Releases the lock, making it available for the next agent requesting it.
Returns the command-line arguments used to start the IBM® software application that started LotusScript®.
Defines a constant.
Returns the cosine of an angle.
Finds the lock ID associated with Name. If none exists, the Lock ID is created.
Creates an OLE Automation object of the specified class.
Returns a value converted to the Single data type.
Returns a value converted to the String data type.
Returns the current directory on a specified drive.
Returns a string identifying the current drive.
Specifies a variable that contains an 8-byte integer, scaled to four decimal places to suitably represent a monetary value.
Returns a value converted to the Variant data type.
Returns the data type of the value of an expression.
Returns the current system date as a date/time value.
Sets the system date.
Returns a date value for a given set of year, month, and day numbers.
Returns the date value represented by a string expression.
Returns the day of the month (an integer from 1 to 31) for a date/time argument.
Declares a LotusScript® function or sub that calls an external C function, allowing calls to a function that is defined in a shared library of C routines.
Declares a forward reference to a procedure (a function, sub, or property), allowing calls to a procedure that has not yet been defined.
Set the default data type for variables, functions, and properties whose names begin with one of a specified group of letters.
Executes an object's Delete sub, if the sub exists, and then deletes the object.
Removes the current link to the lock specified. If the number of links is zero, the lock is destroyed.
Declares variables.
Returns file or directory names from a specified directory, or returns a drive volume label.
Executes a block of statements repeatedly while a given condition is true, or until it becomes true.
Use dot notation to refer to members of user-defined types, user-defined classes, and product classes.
Specifies a variable that contains a double-precision floating-point value maintained as an 8-byte floating point value.
Terminates execution of the currently executing script.
Returns information about an environment variable from the operating system.
Returns an integer value that indicates whether the end of a file has been reached.
Deletes an array, list, or list element.
Returns the line number in the current script procedure where the current error occurred.
Returns the current error number.
Sets the current error number.
Returns an error message for either a specified error number or the current error.
Signals an error number and its corresponding message.
Execute a IBM® software application macro.
Compiles and executes a text expression as a temporary module.
Terminates execution of the current block statement.
Returns the exponential(base e) of a number.
Returns the access type, or the operating system file handle, for an open file.
Makes a copy of a file.
Returns a Date/Time variant showing the date and time that a file was created or last modified.
Returns the length of a file in bytes.
Returns the integer part of a number.
Executes a block of statements a specified number of times.
Executes a block of statements repeatedly for each element of an array, a list, or a collection. "Collection" here refers to a class defined in an LSX and specifically enabled for use with Forall (see the LSX toolkit documentation). Some external programs accessed through OLE automation can also support the use of Forall with their objects.
Formats a number, a date/time, or a string according to a supplied format.
Returns the fractional part of a number.
Returns an unused file number.
Given an array, eliminates "empty" entries and eliminates duplicate, trailing and leading whitespace within entries; and given a string, eliminates duplicate, trailing and leading whitespace in the string.
Defines a function.
Reads data from a binary file or a random file into a variable.
Retrievesfile-system attributes of a file or directory.
Opens an OLE Automation object contained in an application file, or returns the currently active OLE Automation object of the specified class.
Returns system information about the thread.
Transfers control in a procedure to a labeled statement, with an optional return of control.
Transfers control within a procedure to a labeled statement.
Return the hexadecimal representation of a number as a string.
Returns the hour of the day for a date/time argument as an integer from 0 to 23.
Conditionally executes one or more statements or transfers control to a labeled statement, depending on the value of an expression.
Conditionally executes one or more statements, depending on the value of an expression.
Conditionally executes a block of statements, depending on the value of one or more expressions.
Conditionally compiles a block of statements, depending on the value of one or more product constants.
Changes the current input mode (IME) into the mode user specified at its parameter. IMESetMode is supported for Windows™ DBCS system only.
Returns an integer indicating the current input mode (IME) for extended character sets.
Concatenates all members of an Array of Strings and returns a string. Elements of the Array are separated by a delimiter, if provided, or the space character (" ").
At compile time, inserts the contents of a text file into the module where the directive appears.
Reads data from a sequential file and assigns that data to variables.
Reads a sequence of characters from a sequential or binary file into a string variable, without interpreting the input.
Reads a sequence of bytes from a sequential or binary file into a string variable without interpreting the input.
Displays a dialog box containing a prompt for user entry, and returns input from the user as a string.
Reads a sequence of bytes (in the platform-native character set) from a sequential or binary file into a string variable without interpreting the input.
Returns the position of the character that begins the first occurrence of one string within another string.
Returns the position of the byte beginning the first occurrence of one string within another string.
Returns the position of the byte (in the platform-native character set) beginning the first occurrence of one string within another string.
Returns the position of the column that begins the first occurrence of one string within another string for column-based writing systems, such as Thai.
Returns the nearest integer value that is less than or equal to a number.
Specifies a variable that contains a signed 2-byte integer.
Tests the value of an expression to determine whether it is an array.
Tests the value of an expression to determine whether it is a date/time value.
Tests a string expression to determine whether it is the name of a product or platform constant at run time.
Tests a string to determine whether it is a list tag for a given list.
Tests the value of an expression to determine whether it is EMPTY.
Tests the value of an expression to determine whether it is a list.
Tests the value of an expression to determine whether it is NULL.
Tests the value of an expression to determine whether it is numeric, or can be converted to a numeric value.
Tests the value of an expression to determine whether it is a user-defined object, a product object, or an OLE Automation object.
Tests an expression to determine if it evaluates to a single value.
Tests the value of an expression to determine whether it has the OLE value V_IUNKNOWN.
Deletes a file.
Returns the lower bound for one dimension of an array.
Returns the lowercase representation of a string.
Extracts a specified number of the leftmost characters in a string.
IBM® does not recommend using the LeftB function in LotusScript® Release 3 and after because Release 3 and after use Unicode, a character set encoding scheme that represents each character as two bytes. Because a two-byte character can be accompanied by leading or trailing zeroes, extracting characters by byte position no longer yields reliable results.
Extracts a specified number of the leftmost bytes in a string using the platform-specified character set.
Extracts the leftmost n columns from a string for column-based writing systems, such as Thai and Vietnamese.
Returns the number of characters in a string, or the number of bytes used to hold a numeric value.
Returns the length of a string in bytes, or the number of bytes used to hold a variable.
Returns the length of a string in bytes, or the number of bytes used to hold a variable, in the platform-native character set.
Returns the length of a string in number of character columns. The LenC function is used for column based writing systems, such as Thai.
Assigns a value to a variable.
Reads a line from a sequential file into a String or Variant variable.
Returns the name of the list element currently being processed by a ForAll statement.
Returns the current position of the file pointer in a file.
Provide controlled access to files.
Returns the length of an open file in bytes.
Returns the natural (base e) logarithm of a number.
Specifies a variable that contains a signed 4-byte integer.
Assigns a specified string to a string variable and left-aligns the string in the variable.
Removes leading spaces from a string and returns the result.
Displays a message in a message box and waits for user acknowledgment. The function form returns a value corresponding to the button the user presses.
Extracts a string from within another string, beginning with the character at a specified position.
Replaces part or all of one string with characters from another string.
IBM® does not recommend using MidB in LotusScript® Release 3 or later. Because these releases use Unicode, extracting characters by byte position no longer yields reliable results.
IBM® does not recommend using MidB statements in LotusScript® Release 3 or later. Because these releases use Unicode, replacing characters by byte position no longer yields reliable results.
Extracts a number of bytes (using the platform-specified character set) from within another string, beginning at a specified position.
Extracts a number of character columns from a string starting at a character column offset, searching left to right. The MidC function is used for column-based writing systems, such as Thai.
Returns the minute of the hour (an integer from 0 to 59) for a date/time argument.
Creates a directory.
Returns the month of the year (an integer from 1 to 12) for a date/time argument.
Renames a file or directory.
Returns the current system date and time as a date/time value.
Returns the octal representation of a number as a string.
Determines how an error will be handled in the current procedure.
Binds an event-handling sub or function to an event associated with a IBM® software object, or breaks an existing binding.
Transfers control to one of a list of labels, processes statements until a Return statement is reached, and returns control to the statement immediately following the On...GoSub statement.
Transfers control to one of a list of labels.
Opens a file, enabling access to it for reading or writing data.
Sets the default lower bound for array subscripts to 0 or 1.
Specifies the method of string comparison.
Disallows implicit declaration of variables.
Specifies that module-level explicit declarations are Public by default.
Prints data to the screen.
Prints data to a sequential text file.
Define a property. A property is a named pair of Get and Set procedures that can be used as if they were a single variable.
Writes data from a variable to a binary file or a random file.
Seeds (initializes) the random number generator.
Declares a dynamic array and allocates storage for it, or resizes an existing dynamic array.
Indicates a one-line comment in a script.
Indicates one or more comment lines in a script.
Replaces specific words or phrases in a string with new words or phrases that you specify.
Closes all open files, copying the data from each file to disk.
Directs LotusScript® to resume script execution at a particular statement in a script, after an error has occurred.
Transfers control to the statement following a GoSub or On...GoSub statement.
Extracts a specified number of the rightmost characters in a string.
LotusScript® Release 3 and later use Unicode, a character set encoding scheme that represents each character as bytes. This means that a character can be accompanied by leading or trailing zeroes, so IBM® no longer recommends using RightB to work with bytes.
Extracts a specified number of the rightmost bytes in a string using the platform-specified character set.
Extracts the rightmost n columns from a string for column-based writing systems, such as Thai and Vietnamese.
Removes a directory from the file system.
Generates a random number greater than 0 and less than 1.
Rounds a number to a specified number of decimal places.
Assigns a specified string to a string variable and right-aligns the string in the variable.
Remove trailing spaces from a string and return the resulting string.
LotusScript® Release 3 and after no longer support the Run statement. To execute an IBM® software application macro, use the Evaluate function or statement.
Returns the second of the minute (an integer from 0 to 59) for a date/time argument.
Returns the file position (the byte position in a binary file or the record number in a random file) in an open file.
Sets the file position (the byte position in a binary file or the record number in a random file) in an open file.
Selects a group of statements to execute, based on the value of an expression.
Enters keystrokes in the active window as if they were entered from the keyboard.
Assigns an object reference to a variable, or associates an object with a variable.
Sets the system attributes of a file.
Identifies the sign (positive or negative) of a number.
Starts another program.
Starts another program and returns its task ID.
Returns the sine, in radians, of an angle.
Specifies a variable that contains a 4-byte floating-point value.
Causes a script to pause for at least the number of seconds specified. The script may pause longer.
Returns a specified number of spaces as a string.
Inserts a specified number of spaces in the output from a Print or Print # statement, beginning at the current character position.
Returns an Array of Strings that are the substrings of the specified String.
Simulates the occurrence of a breakpoint.
Returns the String representation of a number.
Compares two strings and returns the result.
Converts a string to a different case or character set.
Searches a string from left to right for a pattern and returns a substring consisting of the characters in the string that are to the left of the pattern.
Searches a string from right to left for a pattern and returns a substring consisting of the characters in the string that are to the left of the pattern.
Searches a string from left to right for a pattern and returns a substring consisting of the characters in the string that follow the pattern.
Searches a string from right to left for a pattern and returns a substring consisting of the characters in the string that follow the pattern.
Returns a specified word from a text string.
Specifies a variable used to store text strings, using the character set of the IBM® software application that started LotusScript®. All strings are stored internally as Unicode characters. Strings are translated between platform-specific characters and Unicode characters during I/O operations.
Returns a string consisting of a particular character repeated a number of times. The character is specified as a string, or a value interpreted as a locale-sensitive ASCII character code.
Defines a sub.
A user-defined sub that LotusScript® executes when you delete an object belonging to the class for which the Delete sub is defined.
A user-defined sub that LotusScript® executes when the module containing the Initialize sub is loaded.
A user-defined sub that LotusScript® executes when you create an object of the class for which the New sub is defined.
A user-defined sub that LotusScript® executes when the module containing the Terminate sub is unloaded.
Moves the print position to a specified character position within a line, when called from within a Print or Print # statement.
Returns the tangent, in radians, of an angle.
Returns the system time as a time value.
Sets the system time to a specified time. This statement is not valid on UNIX™ or Macintosh OS X operating systems, for which you need to have root user privileges to change the system time.
Returns a time value for a specified hour, minute, and second.
Returns the time elapsed since midnight, in seconds.
Returns the time value represented by a string expression.
Returns the system date as a date value.
Removes leading and trailing spaces from a string and returns the resulting string.
Defines a user-defined data type consisting of one or more members.
Returns a string identifying the data type of the value of an expression.
Returns the upper bound for one dimension of an array.
Converts all alphabetic characters in a string to uppercase, and returns the resulting string.
Returns the character represented by a Unicode numeric character code.
Returns the Unicode numeric character code for the first character in a string.
Loads a module containing Public definitions needed by the module being compiled.
Loads a LotusScript® extensions (lsx) file containing Public definitions needed by the module being compiled.
Returns a string of identical characters. You can specify the repeating character either by its Unicode numeric code, or as the first character in a string argument.
Returns the numeric value represented by a string.
Specifies a 16-byte variable that can contain data of any scalar type, an array, a list, or an object.
Returns the day of the week, an integer from 1 to 7, for a date/time argument.
Executes a block of statements repeatedly while a given condition is true.
Assigns an output width to a sequential text file.
Provides a shorthand notation for referring to members of an object.
Writes data to a sequential text file with delimiting characters.
Returns the year, as a 4-digit integer, for a date/time argument.
Transfers control to the operating system during script execution.
This appendix describes LotusScript® language limits of several kinds: for example, the legal ranges in data representation, the limits on numerical specifications within statements, and the maximum number of different kinds of elements that can be defined in a script.
The LotusScript® language and functionality on the UNIX™ platform, the Macintosh platform, and the OS/400® platform differ in various ways from the language and functionality described in the rest of this language reference. This appendix describes the differences.
This appendix provides an overview of REXX integration in the LotusScript® language.
This appendix lists the LotusScript® aliases and their equivalent text.
This chapter describes the compile-time error messages in the LotusScript® language.
This chapter describes the run-time error messages in the LotusScript® language.
This section documents the Java/CORBA classes.
Lotus® Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.
Dim root As Double root# = Sqr(169) Print root# ' Prints 13