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.
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 5 LCField Class
This chapter provides information about the LCField class methods and properties.
GetFormatStream Method for LCField
This method retrieves the format of a stream type field. It is only valid for fields of type text or binary.

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.5?
  The following features are new for developers in HCL Domino® Designer 14.5.
- 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.
    - 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.
      - LCField class overview
        The LCField class represents a data object containing one or more data values of a designated data type. Most of the methods in the LCField class have an "index" argument, specifying which of the potentially multiple values in the field to operate on. Index values start at 1.
      - Syntax for HEI Scripted Activities - 1
        When writing LotusScript® Extensions (LC LSX) scripts for 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 HCL Enterprise Integrator (HEI) connection documents.
      - LCField Class Methods and Properties Summary
        The methods for the LCField class are summarized as follows.
      - New Method for LCField
        This is the constructor method for LCField. It initializes an LCField object.
      - ClearVirtualCode Method for LCField
        This method clears the specified virtual code for the field. Virtual codes flag fields as special system properties recognized by different systems. Refer to the connector documentation for specific codes supported by each connection.
      - Compare Method for LCField
        This method compares data values between two fields and returns the relationship.
      - Convert Method for LCField
        This method converts data values to the data type of a destination field.
      - Copy Method for LCField
        This method creates a field with the settings and values of a source field. The new field contains the same number of data values of the same data type as the source field. The new values are copies of, rather than references to, the original data.
      - GetCurrency Method for LCField
        This method retrieves a Currency data type from a value in a field. If the requested data type is different from the field data type, conversion is automatically performed. If conversion is not possible, error LCFAIL_INVALID_CONVERT occurs.
      - GetDatetime Method for LCField
        This method retrieves a Datetime data type from a value in a field. If the requested data type is different from the field data type, conversion is automatically performed. If conversion is not possible, error LCFAIL_INVALID_CONVERT occurs.
      - GetFieldlist Method for LCField
        This method retrieves a fieldlist from a field. The resulting fieldlist is a reference to the original inside the field. If the field doesn't contain an LCFieldlist as its value, an LCFAIL_INVALID_CONVERT error will occur.
      - GetFloat Method for LCField
        This method retrieves a LotusScript® double data type from a value in a field. If the requested data type is different from the field data type, conversion is automatically performed.
      - GetFormatDatetime Method for LCField
        This method retrieves the format of a Datetime type field. It is only valid for fields of type Datetime.
      - GetFormatNumber Method for LCField
        This method retrieves the format of a number type field. It is only valid for fields of type int, currency, float or numeric.
      - GetFormatStream Method for LCField
        This method retrieves the format of a stream type field. It is only valid for fields of type text or binary.
      - GetInt Method for LCField
        This method retrieves an integer from a value in a field. If the requested data type is different from the field data type, conversion is automatically performed. If conversion is not possible, error LCFAIL_INVALID_CONVERT occurs.
      - GetNumeric Method for LCField
        This method retrieves a numeric value from a value in a field. If the requested data type is different from the field data type, conversion is automatically performed. If conversion is not possible, error LCFAIL_INVALID_CONVERT occurs.
      - GetStream Method for LCField
        This method retrieves a stream value from a field. If the requested data type is different from the field data type, conversion is automatically performed. If conversion is not possible, error LCFAIL_INVALID_CONVERT occurs.
      - IsNull Method for LCField
        This method returns true or false depending on whether the specified field data is NULL. A field may potentially contain multiple values, some of which are null and others not.
      - LookupVirtualCode Method for LCField
        This method checks if a specific VirtualCode has been set for a field. Virtual codes flag fields as special system properties recognized by different systems. Refer to the connector documentation for specific codes supported by each connection.
      - SetCurrency Method for LCField
        This method sets a field value to a supplied LCCurrency value. If the field is not of a Currency data type, Notes® will attempt to convert the supplied value to the data type of the field. If conversion fails, error LCFAIL_INVALID_CONVERT will occur.
      - SetDatetime Method for LCField
        This method sets a field value to a supplied LCDatetime value. If the field is not of a datetime data type, Notes® will attempt to convert the supplied value to the data type of the field. If conversion fails, error LCFAIL_INVALID_CONVERT will occur. Datetimes can only be converted to Stream data types.
      - SetFieldlist Method for LCField
        This method assigns the fieldlist value to the specified index of the field. If the field data type is different, an LCFAIL_INVALID_CONVERT error will occur.
      - SetFloat Method for LCField
        This method assigns a value to a field of type float. If the field data type is different, conversion will be attempted. If conversion fails, error LCFAIL_INVALID_CONVERT will occur.
      - SetFormatDatetime Method for LCField
        This method changes the format setting for a datetime field. Calling this method clears all values for this field. The field must be of a datetime type, or error LCFAIL_TYPE_MISMATCH will occur.
      - SetFormatNumber Method for LCField
        This method assigns the current format setting for a number field. Calling this method clears all values for this field.
      - SetFormatStream Method for LCField
        This method assigns the current format setting for a stream field. Calling this method clears all values for this field.
      - SetInt Method for LCField
        This method sets the value of the field to a specified long integer value. If the field is not of type LCTYPE_INT, Notes® tries to convert the value to the field's type. If this fails, error LCFAIL_INVALID_CONVERT will occur.
      - SetNull Method for LCField
        This method sets the value of the field to the special value NULL. This value is recognized by relational databases as representing an empty field (as opposed to a field that contains a zero-length string, for instance).
      - SetNumeric Method for LCField
        This method sets the value of the field to a specified LCNumeric value. If the field is not of type LCTYPE_NUMERIC, Notes® tries to convert the value to the field's type. If this fails, error LCFAIL_INVALID_CONVERT will occur.
      - SetStream Method for LCField
        This method sets the value of the field to a specified LCStream value (text or binary). If the field is not of type LCTYPE_STREAM, or is of that type but uses a format that does not match the supplied value (text as opposed to binary, for instance), Notes® tries to convert the value to the field's type. If this fails, error LCFAIL_INVALID_CONVERT will occur.
      - SetVirtualCode Method for LCField
        This method adds a virtual code to the list of virtual codes for a field. Virtual codes flag fields as special system properties recognized by different systems. Refer to the connector documentation for specific codes supported by each connection.
    - 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.
    - 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.

GetFormatStream Method for LCField

This method retrieves the format of a stream type field. It is only valid for fields of type text or binary.

Use the LCField.SetFormatStream method to assign stream format information. Refer to the Field Format section for a description of format values.

Defined In

LCField

Syntax

Call thisField.GetFormatStream (streamFlags, maxLength, streamFormat)

Parameters

All GetFormatStream parameters are outputs.


Value	Description
streamFlags	Long. Optional. Stream flags for the field. Refer in this chapter to "LCField Class Methods and Properties Summary," Stream Class section for a description of the flags.
maxLength	Long. Optional. Maximum length of the stream field. A value of zero indicates no maximum length.
streamFormat	Long. Optional. Stream format of the stream field. A value of zero indicates no specified stream format.

Example

Option Public
Uselsx "*lsxlc"  
Sub Initialize
  Dim field As New LCField (LCTYPE_BINARY)
  Dim fmt As Long
  Dim flags As Long
  Call field.SetFormatStream (LCSTREAMF_NO_CASE, 256, LCSTREAMFMT_BIG5)
  Call field.GetFormatStream (flags, , fmt)
  Print "The stream format and flag settings are:"
  Print "format=" & fmt & " flags=" & Hex(flags) & "h"
End Sub

Example Output

The stream format and flag settings are:
format=26 flags=10h