Home
HCL Domino Designer Basic 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.
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.
Chapter 9 LCStream Class
This chapter provides information about the LCStream class methods and properties.
SetFormat Method for LCStream
This method sets the format for an LCStream object, converting the stream data if necessary. This method may be more efficient than the Convert method, since a second stream is not required.

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 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.
- 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.
    - Chapter 1 Introduction
      This chapter provides an introduction to the LotusScript® Extension for Connectors (LC LSX) and explains the organization of this manual.
    - Chapter 2 LCConnection Class
      This chapter provides information about the LCConnection class methods and properties.
    - Chapter 3 LCCurrency Class
      This chapter provides information about the LCCurrency class methods and properties.
    - Chapter 4 LCDatetime Class
      This chapter provides information about the LCDatetime class methods and properties.
    - Chapter 5 LCField Class
      This chapter provides information about the LCField class methods and properties.
    - Chapter 6 LCFieldlist Class
      This chapter provides information about the LCFieldlist class methods and properties.
    - Chapter 7 LCNumeric Class
      This chapter provides information about the LCNumeric class methods and properties.
    - Chapter 8 LCSession Class
      This chapter provides information about LCSession class methods and properties.
    - Chapter 9 LCStream Class
      This chapter provides information about the LCStream class methods and properties.
      - LCStream class overview
        The LCStream class represents text and binary data types. A stream value is a variable-length list of characters or bytes. Streams come in two basic types, text and binary, represented by the format of the stream. Specific format information indicates either the character set (for text) or the binary format (for binary).
      - Syntax for HEI Scripted Activities - 5
        When writing LotusScript® Extensions (LC LSX) scripts for HCL Enterprise Integrator (HEI) Scripted activities, you must specify Dim LCSession as a named session (this becomes the default log document name). LCConnections must also be dimensioned as existing, named HEI connection documents.
      - LCStream Type TEXT Format and Values
        The following table shows the format and values for the TEXT type.
      - LCStream Type BINARY Format and Values
        The following table show format and values for the BINARY type.
      - Stream Flags
        The StreamFlags of a stream determine the behavior of the stream under particular circumstances:
      - Stream Format
        The Format of a stream indicates the structure of the stream data. The flag LCSTREAMFMTF_BINARY indicates whether the stream is of a binary format or a text format.
      - LCStream Properties
        The LCStream properties are described in the following table.
      - New Method for LCStream
        This is the constructor method for the LCStream class. It creates an empty LCStream object and optionally assigns initial properties.
      - Clear Method for LCStream
        This method clears a stream value and properties.
      - Append Method for LCStream
        This method appends one stream to another to yield a third LCStream object (the destination object) containing the data from both.
      - Compare Method for LCStream
        This method compares two LCStream objects to determine if they are equal or unequal. If the streams are of different formats, they will first be converted to the same format. If both streams are text, they may be converted to Unicode for comparison. In a text comparison, if either stream has the flag LCSTREAMF_NO_CASE set, then a case-insensitive text comparison will be done.
      - Convert Method for LCStream
        This method obtains a stream in a particular stream format.
      - Copy Method for LCStream
        This method copies the value of one LCStream object to another. The actual data are copied, not just referenced.
      - Extract Method for LCStream
        This method creates a stream from part of the data of an existing stream.
      - Merge Method for LCStream
        This method combines one stream into another, producing a new stream.
      - ResetFormat Method for LCStream
        This method resets the format of an LCStream object, without affecting the data or other properties. This differs from SetFormat, which changes the format and also converts the data.
      - SetFormat Method for LCStream
        This method sets the format for an LCStream object, converting the stream data if necessary. This method may be more efficient than the Convert method, since a second stream is not required.
      - Trim Method for LCStream
        This method trims trailing spaces from text streams. If the stream is not a text format or if the stream has the flag LCSTREAM_NO_TRIM set, then this method will perform no action.
      - DatetimeListGetRange Method for LCStream
        This method gets a range of values in an LCStream DatetimeList object.
      - DatetimeListGetValue Method for LCStream
        This method retrieves a datetime value from a specified place in a DateTimeList LCStream object.
      - DatetimeListInsertRange Method for LCStream
        This method inserts a datetime range into a datetime list stream object.
      - DatetimeListInsertValue Method for LCStream
        This method inserts a value into a datetime list LCStream object.
      - DatetimeListRemoveRange Method for LCStream
        This method removes a range from a datetime list LCStream object.
      - DatetimeListRemoveValue Method for LCStream
        This method removes a value from a datetime list LCStream object.
      - NumberListGetRange Method for LCStream
        This method selects a particular range from a number list LCStream object.
      - NumberListGetValue Method for LCStream
        This method retrieves a specified value from a number list LCStream object.
      - NumberListInsertRange Method for LCStream
        This method inserts a number range into a number list LCStream object.
      - NumberListInsertValue Method for LCStream
        This method inserts a value into a number list LCStream object.
      - NumberListRemoveRange Method for LCStream
        This method removes a range of numbers as indicated by an index from a number list LCStream object.
      - NumberListRemoveValue Method for LCStream
        This method removes a value at a specified position from a number list LCStream object.
      - TextListFetch Method for LCStream
        This method fetches a text list from a text list stream object and assigns it to another stream object.
      - TextListInsert Method for LCStream
        This method inserts text or a text list into a text list LCStream object.
      - TextListRemove Method for LCStream
        This method removes a string from a text list LCStream object.
    - Appendix A Error Messages
      This appendix provides information about error messages.
    - Appendix B Connector Property Tokens
      This appendix provides information about the property tokens used in the LotusScript® Extensions (LC LSX).
    - Appendix C Connector Properties
      This chapter provides information about connector properties. These properties are used when creating connections using the Lotus® Connector LotusScript® Extensions.
    - Appendix D Character Sets
      This appendix provides information about character sets, including character set translation, character sort order, and a list of the character sets supported by the Connector LotusScript® Extensions (LC LSX).
    - Appendix E Additional Scripting Capability for HEI
      This appendix provides information about additional methods and properties provided for HCL Enterprise Integrator (HEI) with the LCSession class that expand on the Connector LotusScript® Extensions (LC LSX).
  - 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.
- 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.

SetFormat Method for LCStream

This method sets the format for an LCStream object, converting the stream data if necessary. This method may be more efficient than the Convert method, since a second stream is not required.

Defined In

LCStream

Syntax

Call lcStream .setFormat (format)

Parameters


Parameter	Description
format	Long. The format to which to set the stream object. See the list of stream formats in the section entitled "Stream Formats" earlier in this chapter. The data will be converted to this stream format.

Example

Option Public
Uselsx "*lsxlc" 
Sub Initialize
  Dim msg As New LCStream (0, 0, LCSTREAMFMT_ASCII)
  msg.Text = "Peter Pan lived in Never Never Land."
  Print "The length of the msg in ASCII is " & msg.Length
  Call msg.SetFormat (LCSTREAMFMT_UNICODE)
  Print "The length of the msg in Unicode is " & msg.Length
End Sub

Example Output

The length of the msg in ASCII is 36.
The length of the msg in Unicode is 72.