.. _func_streams_readstream:

==========
ReadStream
==========

ReadStream - 

Description
===========

.. code-block:: blitzmax

    ReadStream:TStream( url:Object )

Open a stream for reading
All streams created by #OpenStream, #ReadStream or #WriteStream should eventually
be closed using #CloseStream.

Parameters
==========

Return Values
=============

A stream object

Examples
========

.. code-block:: blitzmax

    ' readstream.bmx
    
    ' opens a read stream to the blitzbasic.com website and
    ' dumps the homepage to the console using readline and print
    
    in=ReadStream("http::blitzbasic.com")
    
    If Not in RuntimeError "Failed to open a ReadStream to file http::www.blitzbasic.com"
    
    While Not Eof(in)
        Print ReadLine(in)
    Wend
    CloseStream in

See Also
========