Read( ) method (InputStream)

This method reads data from an input stream and stores the information in the specified location or variable. It returns the total number of characters read for CHARACTER and LONGCHAR data targets, or the total number of bytes read for a MEMPTR target.

Return type: INT64

Access: PUBLIC

Applies to: Progress.IO.InputStream class

Syntax

ABSTRACT Read( INPUT target AS MEMPTR,
               INPUT offset AS INT64,
               INPUT length AS INT64 )

Read( INPUT target AS MEMPTR )

ABSTRACT Read( INPUT delimiter AS CHARACTER,
               OUTPUT target AS CHARACTER )

ABSTRACT Read( INPUT delimiter AS CHARACTER,
               OUTPUT target AS LONGCHAR )

delimiter

When specified, the method reads from the current input stream until it encounters the value in this CHARACTER variable.

length

Indicates how many bytes the method should read from the current input stream.

offset

Indicates which byte of the target MEMPTR the method should start writing to.

target

A CHARACTER, LONGCHAR, or MEMPTR variable that the method uses to store the data it reads.

Notes

• All of the overloads of this method are abstract except for Read( INPUT target AS MEMPTR ). The behavior described for the parameters of the abstract methods are provided as guidelines.
• The method reads data from the file input stream until the MEMPTR is filled, the number of bytes specified by length is read, or the end of the stream is reached, whichever happens first.