Home
HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
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.
Accessing external databases through LS:DO
Developers are advised not to use LS:DO. Developers should use the Connector LSX for (LCLSX) when accessing external data sources.
ODBCResultSet (LotusScript)
Represents the ODBC data access features for performing operations on a result set.
IsBeginOfData (ODBCResultSet - LotusScript)
Indicates whether the cursor position is at the beginning of the result set.

HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 14?
  The following features are new for developers in HCL Domino® Designer 14.
- What's new in Nomad Designer?
  HCL Nomad for web browsers v1.0.10 introduces the capability to design Notes databases. For more information, see HCL Nomad for web browsers User Documentation, Nomad web Designer.
- 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.
- 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.
  - Connectors and Connectivity Guide
  - LSX for Connectors
    LotusScript® Extensions for Connectors (LC LSX) enhances the power of Notes® by extending its scripting to data outside of Notes through the use of Connectors. The programming model is independent of the individual connector. This eliminates the need to learn each individual system, while at the same time allowing experienced users to access the individual features of a specific system.
  - Accessing external databases through LS:DO
    Developers are advised not to use LS:DO. Developers should use the Connector LSX for (LCLSX) when accessing external data sources.
    - Setting up LS:DO
      Setting up LS:DO requires several steps, in which you install any needed software, register your data sources, and then create your script. Review the following sections as you set up LS:DO for your application:
    - Using LS:DO
      Once you have set up LS:DO and your script, you are ready to access your external databases. With LS:DO, you can:
    - Tips and techniques
      This section presents specialized topics concerned with enhancing your LS:DO application:
    - ODBCConnection (LotusScript)
      Represents the ODBC Data Access features for connecting to a data source.
    - ODBCQuery (LotusScript)
      Represents the ODBC data access features for defining an SQL statement.
    - ODBCResultSet (LotusScript)
      Represents the ODBC data access features for performing operations on a result set.
      - Examples: ODBCResultSet class
        This agent executes an SQL query. The agent also displays some of the ODBCResultSet properties after the Execute method and after all the rows in the result set are accessed.
      - CacheLimit (ODBCResultSet - LotusScript)
        Read-write. The maximum number of rows to be cached in memory.
      - Connection (ODBCResultSet - LotusScript)
        Write-only. Relates a connection object with a result set.
      - CurrentRow (ODBCResultSet - LotusScript)
        Read-write. The number of the current row in a result set, starting from row 1.
      - FetchBatchSize (ODBCResultSet - LotusScript)
        Read-write. Specifies the number of records that will be fetched at any one time. The default is 1 (get just the requested record).
      - MaxRows (ODBCResultSet - LotusScript)
        Read-write. Maximum number of rows fetched to the result set, or 0 to fetch all rows subject to memory limits.
      - Query (ODBCResultSet - LotusScript)
        Write-only. Relates an ODBCQuery object with a result set.
      - ReadOnly (ODBCResultSet - LotusScript)
        Read-write. Indicates whether a result set is read-only. Can be set to True to prevent updates.
      - TrimTrailingSpaces (ODBCResultSet - LotusScript)
        Read-write. Indicates whether trailing spaces are trimmed from character values upon retrieval. Can be set to False to prevent trimming.
      - AddRow (ODBCResultSet - LotusScript)
        Adds a workspace for a new row.
      - Close (ODBCResultSet - LotusScript)
        Close a result set.
      - DeleteRow (ODBCResultSet - LotusScript)
        Deletes the record represented by the current row of the result set from the specified table in the external database.
      - ExecProcedure (ODBCResultSet - LotusScript)
        Executes a stored SQL procedure.
      - Execute (ODBCResultSet - LotusScript)
        Executes an SQL statement.
      - FieldExpectedDataType (ODBCResultSet - LotusScript)
        Gets or sets the data type for a column.
      - FieldID (ODBCResultSet - LotusScript)
        Returns the field ID of a field as an integer value, given the field name.
      - FieldInfo (ODBCResultSet - LotusScript)
        Returns an array of field information.
      - FieldName (ODBCResultSet - LotusScript)
        Returns the field name for a specified column, given its ID (column number).
      - FieldNativeDataType (ODBCResultSet - LotusScript)
        Given a specific column, returns the native data type for that column.
      - FieldSize (ODBCResultSet - LotusScript)
        Returns the maximum size of data for a field.
      - FirstRow (ODBCResultSet - LotusScript)
        Sets the current row to the first row in a result set. Equivalent to setting CurrentRow to 1.
      - GetError (ODBCResultSet - LotusScript)
        Returns the latest error code for an ODBC object.
      - GetErrorMessage (ODBCResultSet - LotusScript)
        Returns the short error message text associated with an error code.
      - GetExtendedErrorMessage (ODBCResultSet - LotusScript)
        Returns the long, descriptive error message text associated with an error code.
      - GetParameter (ODBCResultSet - LotusScript)
        Returns the last value set for the specified parameter.
      - GetParameterName (ODBCResultSet - LotusScript)
        Retrieves a parameter name.
      - GetRowStatus (ODBCResultSet - LotusScript)
        Returns the alteration status of the current row.
      - GetValue (ODBCResultSet - LotusScript)
        Retrieves the value of the column referenced by column_id%, and copies the results to the variable field.
      - HasRowChanged (ODBCResultSet - LotusScript)
        Indicates whether values in the current row have changed in the data source; that is, indicates whether values differ from what was fetched into the result set.
      - IsBeginOfData (ODBCResultSet - LotusScript)
        Indicates whether the cursor position is at the beginning of the result set.
        Examples: IsBeginOfData method
        This agent accesses all rows of a result set starting from the last row. You must explicitly set LastRow and process it outside the loop. In the loop, each PrevRow gets the previous row in the data set. IsBeginOfData detects that the first row was processed.
      - IsEndOfData (ODBCResultSet - LotusScript)
        Indicates whether the cursor position is at the end of the result set.
      - IsResultSetAvailable (ODBCResultSet - LotusScript)
        Indicates whether the execution of a query yielded any data.
      - IsValueAltered (ODBCResultSet - LotusScript)
        Indicates whether a column value was altered by SetValue.
      - IsValueNull (ODBCResultSet - LotusScript)
        Indicates whether a column value is a null data value.
      - LastRow (ODBCResultSet - LotusScript)
        Sets the current row position to the last row in the result set.
      - LocateRow (ODBCResultSet - LotusScript)
        Identifies records that match a specified field value.
      - NextRow (ODBCResultSet - LotusScript)
        Sets the current row position to the next row in a result set.
      - NumColumns (ODBCResultSet - LotusScript)
        Number of columns in a result set.
      - Examples: NumColumns method
      - NumParameters (ODBCResultSet - LotusScript)
        Returns the number of parameters in an SQL statement.
      - NumRows (ODBCResultSet - LotusScript)
        Number of rows in a result set.
      - PrevRow (ODBCResultSet - LotusScript)
        Positions the current row pointer at the previous row.
      - SetParameter (ODBCResultSet - LotusScript)
        Sets the replacement value for the specified parameter.
      - SetValue (ODBCResultSet - LotusScript)
        Sets a new value to a column.
      - UpdateRow (ODBCResultSet - LotusScript)
        Updates the current row, if changed, to the database.
- 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.

IsBeginOfData (ODBCResultSet - LotusScript)

Indicates whether the cursor position is at the beginning of the result set.

Defined in

ODBCResultSet

Syntax

flag% = odbcResultSet . IsBeginOfData

Return value

True indicates that the cursor is on the first record.
False indicates that the cursor is not on the first record, or the result set has 0 rows.

Usage

When IsBeginOfData returns False, it could mean that the result set is empty. If you do not know whether any rows were returned from your query, use the IsResultSetAvailable method to test whether data is available before using methods that assume data is present.

Errors

Not connected to a data source (DBstsNCON)

The result contains no data (DBstsNODA)

Example