View source for System.Classes.TStream.Read

{{#lst:API:System.Classes.TStream.Read|api}}
==Description==
{{#ifeq: {{PAGENAME}} | System.Classes.TStream.Read | |{{InheritsFrom|System.Classes.TStream.Read}}}}

<section begin=short />Methods responsible for reading  up to {{Arg|Count}} bytes of data  from the stream into {{Arg|Buffer}}.<section end=short />

Descendant stream classes can define its own '''Read''' methods that read data from its particular storage medium (such as memory or a disk file) into a {{Arg|Buffer}} buffer.

[[System.Classes.TStream.Read|Read]] is used in cases where the number of bytes to read from the stream is not necessarily fixed. 

[[System.Classes.TStream.Read|Read]] attempts to read, into {{Arg|Buffer}}, up to {{Arg|Count}} bytes from the stream, starting at the current [[System.Classes.TStream.Position|position]], and then advances the current position in the stream by the number of bytes actually transferred. [[System.Classes.TStream.Read|Read]] returns the number of bytes actually read, which may be less than {{Arg|Count}}.

{{Arg|Offset}} specifies a zero-based position in {{Arg|Buffer}} from which to write the first byte into {{Arg|Buffer}}. 

All the other data-reading methods of a stream ([[System.Classes.TStream.ReadBuffer|ReadBuffer]], [[System.Classes.TStream.ReadData|ReadData]]) call [[System.Classes.TStream.Read|Read]] to do their actual reading.

===See Also===

* [[System.SysUtils.TBytes]]
* [[System.Classes.EReadError]]
* [[System.Classes.TStream.ReadBuffer]]
* [[System.Classes.TStream.ReadData]]
* [[System.Classes.TStream.ReadBufferData]]
* [[System.Classes.TStream.ReadComponent]]

[[Category:API Documentation]]