Working with streams of data

The NotesStream class lets you examine and manipulate files as streams of binary or character data. Use the CreateStream class in the NotesSession class to create a new NotesStream object.

The following table lists the NotesStream properties.

Property

Data type

Description

Bytes

Long

(Read-only) Returns the size of the stream in number of bytes.

CharSet

String

(Read-only) Specifies the character set used by the external data source.

IsEOS

Boolean

(Read-only) Indicates whether the current position is at the end of the stream.

IsReadOnly

Boolean

(Read-only) Indicates whether the stream is associated with a read-only file.

Position

Long

(Read-write) Offset from the beginning of the stream in bytes. Used as a starting point by Read and ReadText.

Use the Write or WriteText method to put data into a stream. Use the Read or ReadText method to get data from a stream. Use the Truncate method to delete the contents of a stream.

Use the OpenMethod to associate a stream with a file and to copy the file contents into the stream. If the file does not exist, the Open method creates a new file. Use any of the read or write methods to process the data. Use the Close method to release system resources associated with the stream.