LCStream Properties

The LCStream properties are described in the following table.

Value

Description

Flags

Long. The flags for the stream.

Format

Long. The stream data format. This can be assigned, but to convert between character sets or formats, use the SetFormat method.

Length

Long. The length of the stream data, in bytes. For text streams, the length in characters may be less, depending on the character set in use.

MaxLength

Long. The maximum valid data length for the stream. A value of zero indicates no maximum [Read-Only].

Text

String. The value of the stream object, converted to the IBM® Lotus® LotusScript® string representation. This property can be assigned to set the value of the stream. For list types, use comma as a delimiter between list elements.

Note: A text list may also contain commas in the values of the individual elements, so when working with text lists, use the Value property for assignments.

Value

Variant. An array with starting index 0. You may assign this property to set the value. The size of the array and data type of the elements depends on the stream format.

  • TEXT -- an array containing a single element of type String.
  • TEXT LIST -- an array containing Valuecount elements of type String.
  • NUMBER LIST -- an array containing Valuecount elements of type Double.
  • DATE/TIME LIST -- an array containing Valuecount elements of type date/time variant.
Note: Certain methods accept an index parameter to manipulate single elements within a list stream. These indexes start at 1, whereas the Value array starts at zero.

ValueCount

Long. Number of elements in a stream. Valid only for List<Type> formats. [Read-Only]

Note: Datetime and number lists may contain a mixture of single values and range values. ValueCount returns the number of single values.

RangeCount

Long. The number of range elements in a stream. Valid only for List<Type> formats. [Read-Only]