Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
LotusScript® Language
Welcome to the LotusScript® Language section of Domino® Designer Help.
LotusScript® Language Reference
This chapter describes the use of statements, built-in functions, subs, data types, and directives in the LotusScript® language.
FileAttr function (LotusScript® Language)
Returns the access type, or the operating system file handle, for an open file.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in HCL Domino Designer 12?
  The following features are new for developers in HCL Domino® Designer 12.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  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.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
  - Introduction to LotusScript®
    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.
  - Script and Statement Construction Rules
    This chapter describes the rules for writing the basic elements of a script in the LotusScript® language.
  - Data Types, Constants, and Variables
    This chapter provides information about LotusScript® constants and variables and the data types of the values that they can represent.
  - Expressions and Operators
    This chapter describes the set of LotusScript® operators, how they may be combined with operands to form expressions, and how those expressions are evaluated.
  - Procedures: Functions, Subs, and Properties
  - File Handling
    This chapter describes file handling in the LotusScript® language.
  - Error Processing
    This chapter describes error processing in the LotusScript® language.
  - User-Defined Data Types and Classes
    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.
  - Managing Flow in Scripts
    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.
  - Managing Asynchronous Web Agents in Domino®
    This chapter describes how to use multiple threads and synchronization to manage HTTP agents with Domino®.
  - Beyond Core LotusScript®
    This chapter discusses the role that LotusScript® plays with HCL products, your operating environment, other programs, and interactive user applications.
  - LotusScript® Language Reference
    This chapter describes the use of statements, built-in functions, subs, data types, and directives in the LotusScript® language.
    - LotusScript® Language Reference: A through D
      Listed here are the reference topics from A to D.
    - LotusScript® Language Reference: E through H
      Listed here are the reference topics from E to H.
    - LotusScript® Language Reference: I through L
      Listed here are the reference topics from I to L.
    - LotusScript® Language Reference: M through P
      Listed here are the reference topics from M to P.
    - LotusScript® Language Reference: Q through T
      Listed here are the reference topics from Q to T.
    - LotusScript® Language Reference: U through Z
      Listed here are the reference topics from U to Z.
    - Abs function (LotusScript® Language)
      Returns the absolute value of a numeric expression.
    - ACos function (LotusScript® Language)
      Returns the arccosine, in radians, of a number between -1 and 1, inclusive.
    - ActivateApp statement (LotusScript® Language)
      Makes a program window the active window.
    - ArrayAppend function (LotusScript® Language)
      Appends an array or scalar value to an array and returns the result as an array.
    - ArrayGetIndex function (LotusScript® Language)
      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.
    - ArrayReplace function (LotusScript® Language)
      Performs a search and replace routine for multiple values within an array.
    - ArrayUnique function (LotusScript® Language)
      Removes duplicate elements from an Array.
    - Asc function (LotusScript® Language)
      Returns the locale-sensitive ASCII character code for the first character in a string.
    - ASin function (LotusScript® Language)
      Returns the arcsine, in radians, of a number between -1 and 1, inclusive.
    - ATn function (LotusScript® Language)
      Returns the arctangent, in radians, of a number.
    - ATn2 function (LotusScript® Language)
      Returns the polar coordinate angle, in radians, of a point in the Cartesian plane.
    - Beep statement (LotusScript® Language)
      Generates a tone on the computer.
    - Bin function (LotusScript® Language)
      Returns the binary representation of a number as a string.
    - Boolean data type (LotusScript® Language)
      Specifies a variable that contains a True (-1) or False (0) value.
    - Bracket notation (LotusScript® Language)
      For applications developed with some HCL products, you can use names in brackets rather than object reference variables to identify HCL software objects. To determine whether your software supports this notation, see the product documentation.
    - Byte data type (LotusScript® Language)
      Specifies a variable that contains a single, one-byte unsigned number.
    - Call statement (LotusScript® Language)
      Calls a LotusScript® sub or function.
    - CBool function (LotusScript® Language)
      Returns an expression converted to the Boolean data type.
    - CByte function (LotusScript® Language)
      Returns an expression converted to the Byte data type.
    - CCur function (LotusScript® Language)
      Returns a value converted to the Currency data type.
    - CDat function (LotusScript® Language)
      Converts a numeric value or string value to a date/time value.
    - CDbl function (LotusScript® Language)
      Returns a value converted to the Double data type.
    - ChDir statement (LotusScript® Language)
      Sets the current directory.
    - ChDrive statement (LotusScript® Language)
      Sets the current drive.
    - Chr function (LotusScript® Language)
      Returns the character represented by a value interpreted as a locale-sensitive character code.
    - CInt function (LotusScript® Language)
      Returns a value converted to the Integer data type.
    - Class statement (LotusScript® Language)
      Defines a class with its member variables and procedures.
    - CLng function (LotusScript® Language)
      Returns a value converted to the Long data type.
    - Close statement (LotusScript® Language)
      Closes one or more open files, after writing all internally buffered data to the files.
    - CodeLock function (LotusScript® Language)
      Acquires the lock specified by ID.
    - CodeLockCheck function (LotusScript® Language)
      Returns the number of agents waiting for the the specified lock, plus 1.
    - CodeUnlock function (LotusScript® Language)
      Releases the lock, making it available for the next agent requesting it.
    - Command function (LotusScript® Language)
      Returns the command-line arguments used to start the software application that started LotusScript®.
    - Const statement (LotusScript® Language)
      Defines a constant.
    - Cos function (LotusScript® Language)
      Returns the cosine of an angle.
    - CreateLock function (LotusScript® Language)
      Finds the lock ID associated with Name. If none exists, the Lock ID is created.
    - CreateObject function (LotusScript® Language)
      Creates an OLE Automation object of the specified class.
    - CSng function (LotusScript® Language)
      Returns a value converted to the Single data type.
    - CStr function (LotusScript® Language)
      Returns a value converted to the String data type.
    - CurDir function (LotusScript® Language)
      Returns the current directory on a specified drive.
    - CurDrive function (LotusScript® Language)
      Returns a string identifying the current drive.
    - Currency data type (LotusScript® Language)
      Specifies a variable that contains an 8-byte integer, scaled to four decimal places to suitably represent a monetary value.
    - CVar function (LotusScript® Language)
      Returns a value converted to the Variant data type.
    - DataType function (LotusScript® Language)
      Returns the data type of the value of an expression.
    - Date function (LotusScript® Language)
      Returns the current system date as a date/time value.
    - Date statement (LotusScript® Language)
      Sets the system date.
    - DateNumber function (LotusScript® Language)
      Returns a date value for a given set of year, month, and day numbers.
    - DateValue function (LotusScript® Language)
      Returns the date value represented by a string expression.
    - Day function (LotusScript® Language)
      Returns the day of the month (an integer from 1 to 31) for a date/time argument.
    - Declare statement (external C calls) (LotusScript® Language)
      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.
    - Declare statement (forward reference) (LotusScript® Language)
      Declares a forward reference to a procedure (a function, sub, or property), allowing calls to a procedure that has not yet been defined.
    - Deftype statements (LotusScript® Language)
      Set the default data type for variables, functions, and properties whose names begin with one of a specified group of letters.
    - Delete statement (LotusScript® Language)
      Executes an object's Delete sub, if the sub exists, and then deletes the object.
    - DestroyLock function (LotusScript® Language)
      Removes the current link to the lock specified. If the number of links is zero, the lock is destroyed.
    - Dim statement (LotusScript® Language)
      Declares variables.
    - Dir function (LotusScript® Language)
      Returns file or directory names from a specified directory, or returns a drive volume label.
    - Do statement (LotusScript® Language)
      Executes a block of statements repeatedly while a given condition is true, or until it becomes true.
    - Dot notation (LotusScript® Language)
      Use dot notation to refer to members of user-defined types, user-defined classes, and product classes.
    - Double data type (LotusScript® Language)
      Specifies a variable that contains a double-precision floating-point value maintained as an 8-byte floating point value.
    - End statement (LotusScript® Language)
      Terminates execution of the currently executing script.
    - Environ function (LotusScript® Language)
      Returns information about an environment variable from the operating system.
    - EOF function (LotusScript® Language)
      Returns an integer value that indicates whether the end of a file has been reached.
    - Erase statement (LotusScript® Language)
      Deletes an array, list, or list element.
    - Erl function (LotusScript® Language)
      Returns the line number in the current script procedure where the current error occurred.
    - Err function (LotusScript® Language)
      Returns the current error number.
    - Err statement (LotusScript® Language)
      Sets the current error number.
    - Error function (LotusScript® Language)
      Returns an error message for either a specified error number or the current error.
    - Error statement (LotusScript® Language)
      Signals an error number and its corresponding message.
    - Evaluate function and statement (LotusScript® Language)
      Execute a HCL software application macro.
    - Execute function and statement (LotusScript® Language)
      Compiles and executes a text expression as a temporary module.
    - Exit statement (LotusScript® Language)
      Terminates execution of the current block statement.
    - Exp function (LotusScript® Language)
      Returns the exponential(base e) of a number.
    - FileAttr function (LotusScript® Language)
      Returns the access type, or the operating system file handle, for an open file.
      - Examples: FileAttr function
    - FileCopy statement (LotusScript® Language)
      Makes a copy of a file.
    - FileDateTime function (LotusScript® Language)
      Returns a Date/Time variant showing the date and time that a file was created or last modified.
    - FileLen function (LotusScript® Language)
      Returns the length of a file in bytes.
    - Fix function (LotusScript® Language)
      Returns the integer part of a number.
    - For statement (LotusScript® Language)
      Executes a block of statements a specified number of times.
    - ForAll statement (LotusScript® Language)
      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.
    - Format function (LotusScript® Language)
      Formats a number, a date/time, or a string according to a supplied format.
    - Fraction function (LotusScript® Language)
      Returns the fractional part of a number.
    - FreeFile function (LotusScript® Language)
      Returns an unused file number.
    - FullTrim function (LotusScript® Language)
      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.
    - Function statement (LotusScript® Language)
      Defines a function.
    - Get statement (LotusScript® Language)
      Reads data from a binary file or a random file into a variable.
    - GetFileAttr function (LotusScript® Language)
      Retrievesfile-system attributes of a file or directory.
    - GetObject function (LotusScript® Language)
      Opens an OLE Automation object contained in an application file, or returns the currently active OLE Automation object of the specified class.
    - GetThreadInfo function (LotusScript® Language)
      Returns system information about the thread.
    - GoSub statement (LotusScript® Language)
      Transfers control in a procedure to a labeled statement, with an optional return of control.
    - GoTo statement (LotusScript® Language)
      Transfers control within a procedure to a labeled statement.
    - Hex function (LotusScript® Language)
      Return the hexadecimal representation of a number as a string.
    - Hour function (LotusScript® Language)
      Returns the hour of the day for a date/time argument as an integer from 0 to 23.
    - If...GoTo statement (LotusScript® Language)
      Conditionally executes one or more statements or transfers control to a labeled statement, depending on the value of an expression.
    - If...Then...Else statement (LotusScript® Language)
      Conditionally executes one or more statements, depending on the value of an expression.
    - If...Then...ElseIf statement (LotusScript® Language)
      Conditionally executes a block of statements, depending on the value of one or more expressions.
    - %If directive (LotusScript® Language)
      Conditionally compiles a block of statements, depending on the value of one or more product constants.
    - IMESetMode function (LotusScript® Language)
      Changes the current input mode (IME) into the mode user specified at its parameter. IMESetMode is supported for Windows™ DBCS system only.
    - IMEStatus function (LotusScript® Language)
      Returns an integer indicating the current input mode (IME) for extended character sets.
    - Implode function (LotusScript® Language)
      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 (" ").
    - %Include directive (LotusScript® Language)
      At compile time, inserts the contents of a text file into the module where the directive appears.
    - Input # statement (LotusScript® Language)
      Reads data from a sequential file and assigns that data to variables.
    - Input function (LotusScript® Language)
      Reads a sequence of characters from a sequential or binary file into a string variable, without interpreting the input.
    - InputB function (LotusScript® Language)
      Reads a sequence of bytes from a sequential or binary file into a string variable without interpreting the input.
    - InputBox function (LotusScript® Language)
      Displays a dialog box containing a prompt for user entry, and returns input from the user as a string.
    - InputBP function (LotusScript® Language)
      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.
    - InStr function (LotusScript® Language)
      Returns the position of the character that begins the first occurrence of one string within another string.
    - InStrB function (LotusScript® Language)
      Returns the position of the byte beginning the first occurrence of one string within another string.
    - InStrBP function (LotusScript® Language)
      Returns the position of the byte (in the platform-native character set) beginning the first occurrence of one string within another string.
    - InStrC function (LotusScript® Language)
      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.
    - Int function (LotusScript® Language)
      Returns the nearest integer value that is less than or equal to a number.
    - Integer data type (LotusScript® Language)
      Specifies a variable that contains a signed 2-byte integer.
    - IsArray function (LotusScript® Language)
      Tests the value of an expression to determine whether it is an array.
    - IsDate function (LotusScript® Language)
      Tests the value of an expression to determine whether it is a date/time value.
    - IsDefined function (LotusScript® Language)
      Tests a string expression to determine whether it is the name of a product or platform constant at run time.
    - IsElement function (LotusScript® Language)
      Tests a string to determine whether it is a list tag for a given list.
    - IsEmpty function (LotusScript® Language)
      Tests the value of an expression to determine whether it is EMPTY.
    - IsList function (LotusScript® Language)
      Tests the value of an expression to determine whether it is a list.
    - IsNull function (LotusScript® Language)
      Tests the value of an expression to determine whether it is NULL.
    - IsNumeric function (LotusScript® Language)
      Tests the value of an expression to determine whether it is numeric, or can be converted to a numeric value.
    - IsObject function (LotusScript® Language)
      Tests the value of an expression to determine whether it is a user-defined object, a product object, or an OLE Automation object.
    - IsScalar function (LotusScript® Language)
      Tests an expression to determine if it evaluates to a single value.
    - IsUnknown function (LotusScript® Language)
      Tests the value of an expression to determine whether it has the OLE value V_IUNKNOWN.
    - Join function (LotusScript® Language)
      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 (" ").
    - Kill statement (LotusScript® Language)
      Deletes a file.
    - LBound function (LotusScript® Language)
      Returns the lower bound for one dimension of an array.
    - LCase function (LotusScript® Language)
      Returns the lowercase representation of a string.
    - Left function (LotusScript® Language)
      Extracts a specified number of the leftmost characters in a string.
    - LeftB function (LotusScript® Language)
      HCL recommends 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.
    - LeftBP function (LotusScript® Language)
      Extracts a specified number of the leftmost bytes in a string using the platform-specified character set.
    - LeftC function (LotusScript® Language)
      Extracts the leftmost n columns from a string for column-based writing systems, such as Thai and Vietnamese.
    - Len function (LotusScript® Language)
      Returns the number of characters in a string, or the number of bytes used to hold a numeric value.
    - LenB function (LotusScript® Language)
      Returns the length of a string in bytes, or the number of bytes used to hold a variable.
    - LenBP function (LotusScript® Language)
      Returns the length of a string in bytes, or the number of bytes used to hold a variable, in the platform-native character set.
    - LenC function (LotusScript® Language)
      Returns the length of a string in number of character columns. The LenC function is used for column based writing systems, such as Thai.
    - Let statement (LotusScript® Language)
      Assigns a value to a variable.
    - Line Input # statement (LotusScript® Language)
      Reads a line from a sequential file into a String or Variant variable.
    - ListTag function (LotusScript® Language)
      Returns the name of the list element currently being processed by a ForAll statement.
    - LOC function (LotusScript® Language)
      Returns the current position of the file pointer in a file.
    - Lock and Unlock statements (LotusScript® Language)
      Provide controlled access to files.
    - LOF function (LotusScript® Language)
      Returns the length of an open file in bytes.
    - Log function (LotusScript® Language)
      Returns the natural (base e) logarithm of a number.
    - Long data type (LotusScript® Language)
      Specifies a variable that contains a signed 4-byte integer.
    - LSet statement (LotusScript® Language)
      Assigns a specified string to a string variable and left-aligns the string in the variable.
    - LTrim function (LotusScript® Language)
      Removes leading spaces from a string and returns the result.
    - MessageBox function and statement (LotusScript® Language)
      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.
    - Mid function (LotusScript® Language)
      Extracts a string from within another string, beginning with the character at a specified position.
    - Mid statement (LotusScript® Language)
      Replaces part or all of one string with characters from another string.
    - MidB function (LotusScript® Language)
      HCL 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.
    - MidB statement (LotusScript® Language)
      HCL 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.
    - MidBP function (LotusScript® Language)
      Extracts a number of bytes (using the platform-specified character set) from within another string, beginning at a specified position.
    - MidC function (LotusScript® Language)
      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.
    - Minute function (LotusScript® Language)
      Returns the minute of the hour (an integer from 0 to 59) for a date/time argument.
    - MkDir statement (LotusScript® Language)
      Creates a directory.
    - Month function (LotusScript® Language)
      Returns the month of the year (an integer from 1 to 12) for a date/time argument.
    - Name statement (LotusScript® Language)
      Renames a file or directory.
    - Now function (LotusScript® Language)
      Returns the current system date and time as a date/time value.
    - Oct function (LotusScript® Language)
      Returns the octal representation of a number as a string.
    - On Error statement (LotusScript® Language)
      Determines how an error will be handled in the current procedure.
    - On Event statement (LotusScript® Language)
      Binds an event-handling sub or function to an event associated with an HCL software object, or breaks an existing binding.
    - On...GoSub statement (LotusScript® Language)
      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.
    - On...GoTo statement (LotusScript® Language)
      Transfers control to one of a list of labels.
    - Open statement (LotusScript® Language)
      Opens a file, enabling access to it for reading or writing data.
    - Option Base statement (LotusScript® Language)
      Sets the default lower bound for array subscripts to 0 or 1.
    - Option Compare statement (LotusScript® Language)
      Specifies the method of string comparison.
    - Option Declare statement (LotusScript® Language)
      Disallows implicit declaration of variables.
    - Option Public statement (LotusScript® Language)
      Specifies that module-level explicit declarations are Public by default.
    - Print statement (LotusScript® Language)
      Prints data to the screen.
    - Print # statement (LotusScript® Language)
      Prints data to a sequential text file.
    - Property Get/Set statements (LotusScript® Language)
      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.
    - Put statement (LotusScript® Language)
      Writes data from a variable to a binary file or a random file.
    - Randomize statement (LotusScript® Language)
      Seeds (initializes) the random number generator.
    - ReDim statement (LotusScript® Language)
      Declares a dynamic array and allocates storage for it, or resizes an existing dynamic array.
    - Rem statement (LotusScript® Language)
      Indicates a one-line comment in a script.
    - %Rem directive (LotusScript® Language)
      Indicates one or more comment lines in a script.
    - Replace function (LotusScript® Language)
      Replaces specific words or phrases in a string with new words or phrases that you specify.
    - Reset statement (LotusScript® Language)
      Closes all open files, copying the data from each file to disk.
    - Resume statement (LotusScript® Language)
      Directs LotusScript® to resume script execution at a particular statement in a script, after an error has occurred.
    - Return statement (LotusScript® Language)
      Transfers control to the statement following a GoSub or On...GoSub statement.
    - Right function (LotusScript® Language)
      Extracts a specified number of the rightmost characters in a string.
    - RightB function (LotusScript® Language)
      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 HCL no longer recommends using RightB to work with bytes.
    - RightBP function (LotusScript® Language)
      Extracts a specified number of the rightmost bytes in a string using the platform-specified character set.
    - RightC function (LotusScript® Language)
      Extracts the rightmost n columns from a string for column-based writing systems, such as Thai and Vietnamese.
    - RmDir statement (LotusScript® Language)
      Removes a directory from the file system.
    - Rnd function (LotusScript® Language)
      Generates a random number greater than 0 and less than 1.
    - Round function (LotusScript® Language)
      Rounds a number to a specified number of decimal places.
    - RSet statement (LotusScript® Language)
      Assigns a specified string to a string variable and right-aligns the string in the variable.
    - RTrim function (LotusScript® Language)
      Remove trailing spaces from a string and return the resulting string.
    - Run statement (LotusScript® Language)
      LotusScript® Release 3 and after no longer support the Run statement. To execute an HCL software application macro, use the Evaluate function or statement.
    - Second function (LotusScript® Language)
      Returns the second of the minute (an integer from 0 to 59) for a date/time argument.
    - Seek function (LotusScript® Language)
      Returns the file position (the byte position in a binary file or the record number in a random file) in an open file.
    - Seek statement (LotusScript® Language)
      Sets the file position (the byte position in a binary file or the record number in a random file) in an open file.
    - Select Case statement (LotusScript® Language)
      Selects a group of statements to execute, based on the value of an expression.
    - SendKeys statement (LotusScript® Language)
      Enters keystrokes in the active window as if they were entered from the keyboard.
    - Set statement (LotusScript® Language)
      Assigns an object reference to a variable, or associates an object with a variable.
    - SetFileAttr statement (LotusScript® Language)
      Sets the system attributes of a file.
    - Sgn function (LotusScript® Language)
      Identifies the sign (positive or negative) of a number.
    - Shell function (LotusScript® Language)
      Starts another program.
    - Shellid function (LotusScript® Language)
      Starts another program and returns its task ID.
    - Sin function (LotusScript® Language)
      Returns the sine, in radians, of an angle.
    - Single data type (LotusScript® Language)
      Specifies a variable that contains a 4-byte floating-point value.
    - Sleep statement (LotusScript® Language)
      Causes a script to pause for at least the number of seconds specified. The script may pause longer.
    - Space function (LotusScript® Language)
      Returns a specified number of spaces as a string.
    - Spc function (LotusScript® Language)
      Inserts a specified number of spaces in the output from a Print or Print # statement, beginning at the current character position.
    - Split function (LotusScript® Language)
      Returns an Array of Strings that are the substrings of the specified String.
    - Sqr function (LotusScript® Language)
      Returns the square root of a number.
    - Stop statement (LotusScript® Language)
      Simulates the occurrence of a breakpoint.
    - Str function (LotusScript® Language)
      Returns the String representation of a number.
    - StrCompare function (LotusScript® Language)
      Compares two strings and returns the result.
    - StrConv function (LotusScript® Language)
      Converts a string to a different case or character set.
    - StrLeft function (LotusScript® Language)
      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.
    - StrLeftBack function (LotusScript® Language)
      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.
    - StrRight function (LotusScript® Language)
      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.
    - StrRightBack function (LotusScript® Language)
      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.
    - StrToken function (LotusScript® Language)
      Returns a specified word from a text string.
    - String data type (LotusScript® Language)
      Specifies a variable used to store text strings, using the character set of the HCL 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.
    - String function (LotusScript® Language)
      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.
    - Sub statement (LotusScript® Language)
      Defines a sub.
    - Sub Delete (LotusScript® Language)
      A user-defined sub that LotusScript® executes when you delete an object belonging to the class for which the Delete sub is defined.
    - Sub Initialize (LotusScript® Language)
      A user-defined sub that LotusScript® executes when the module containing the Initialize sub is loaded.
    - Sub New (LotusScript® Language)
      A user-defined sub that LotusScript® executes when you create an object of the class for which the New sub is defined.
    - Sub Terminate (LotusScript® Language)
      A user-defined sub that LotusScript® executes when the module containing the Terminate sub is unloaded.
    - Tab function (LotusScript® Language)
      Moves the print position to a specified character position within a line, when called from within a Print or Print # statement.
    - Tan function (LotusScript® Language)
      Returns the tangent, in radians, of an angle.
    - Time function (LotusScript® Language)
      Returns the system time as a time value.
    - Time statement (LotusScript® Language)
      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.
    - TimeNumber function (LotusScript® Language)
      Returns a time value for a specified hour, minute, and second.
    - Timer function (LotusScript® Language)
      Returns the time elapsed since midnight, in seconds.
    - TimeValue function (LotusScript® Language)
      Returns the time value represented by a string expression.
    - Today function (LotusScript® Language)
      Returns the system date as a date value.
    - Trim function (LotusScript® Language)
      Removes leading and trailing spaces from a string and returns the resulting string.
    - Type statement (LotusScript® Language)
      Defines a user-defined data type consisting of one or more members.
    - TypeName function (LotusScript® Language)
      Returns a string identifying the data type of the value of an expression.
    - UBound function (LotusScript® Language)
      Returns the upper bound for one dimension of an array.
    - UCase function (LotusScript® Language)
      Converts all alphabetic characters in a string to uppercase, and returns the resulting string.
    - UChr function (LotusScript® Language)
      Returns the character represented by a Unicode numeric character code.
    - Uni function (LotusScript® Language)
      Returns the Unicode numeric character code for the first character in a string.
    - Unlock statement (LotusScript® Language)
    - Use statement (LotusScript® Language)
      Loads a module containing Public definitions needed by the module being compiled.
    - UseLSX statement (LotusScript® Language)
      Loads a LotusScript® extensions (lsx) file containing Public definitions needed by the module being compiled.
    - UString function (LotusScript® Language)
      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.
    - Val function (LotusScript® Language)
      Returns the numeric value represented by a string.
    - Variant data type (LotusScript® Language)
      Specifies a 16-byte variable that can contain data of any scalar type, an array, a list, or an object.
    - Weekday function (LotusScript® Language)
      Returns the day of the week, an integer from 1 to 7, for a date/time argument.
    - While statement (LotusScript® Language)
      Executes a block of statements repeatedly while a given condition is true.
    - Width # statement (LotusScript® Language)
      Assigns an output width to a sequential text file.
    - With statement (LotusScript® Language)
      Provides a shorthand notation for referring to members of an object.
    - Write # statement (LotusScript® Language)
      Writes data to a sequential text file with delimiting characters.
    - Year function (LotusScript® Language)
      Returns the year, as a 4-digit integer, for a date/time argument.
    - Yield function and statement (LotusScript® Language)
      Transfers control to the operating system during script execution.
  - Language and Script Limits
    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.
  - Platform Differences
    The LotusScript® language and functionality on the UNIX™ platform, the Macintosh platform, and the IBM i® platform differ in various ways from the language and functionality described in the rest of this language reference. This appendix describes the differences.
  - LotusScript/REXX Integration
    This appendix provides an overview of REXX integration in the LotusScript® language.
  - LotusScript® Aliases
    This appendix lists the LotusScript® aliases and their equivalent text.
  - MIME Charset Names
  - Compile-time Error Messages
    This chapter describes the compile-time error messages in the LotusScript® language.
  - Run-time Error Messages
    This chapter describes the run-time error messages in the LotusScript® language.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

FileAttr function (LotusScript® Language)

Returns the access type, or the operating system file handle, for an open file.

Syntax

FileAttr ( fileNumber , attribute )

Elements

fileNumber

The number associated with the file when you opened it.

attribute

A number (either 1 or 2) specifying the type of information you want. Instead of 1 or 2, you can specify the constant ATTR_MODE or ATTR_HANDLE, respectively. These constants are defined in the file lsconst.lss. Including this file in your script allows you to use constants instead of their numeric values.

Return value

If attribute is ATTR_HANDLE, then FileAttr returns the operating system file handle for the file.

If attribute is ATTR_MODE, then FileAttr returns an integer representing the access for the file, as shown in the following table.


Return value	Access	Constant
1	Input	ATTR_INPUT
2	Output	ATTR_OUTPUT
4	Random	ATTR_RANDOM
8	Append	ATTR_APPEND
32	Binary	ATTR_BINARY

Example