Class AFileInputStream

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type AFileInputStream = class(AFileStream)

Description

This class can be used for binary input from a file that can be accessed by the underlying file system.

Hierarchy

Overview

Methods

Public constructor fromFileNamed(const thisName: string); virtual;
Public function read(const count: TStreamIOSize; var dest): TStreamIOSize; override;

Description

Methods

Public constructor fromFileNamed(const thisName: string); virtual;

Construct a new stream instance that will read from the file named by thisName.

thisName may represent a relative or absolute path to the file to be read. If the file does not exist or cannot be accessed for reading, then an exception is raised.

Exceptions raised
AFileStreamOpenError
if the file named by thisName cannot be accessed for reading.
Public function read(const count: TStreamIOSize; var dest): TStreamIOSize; override;

Read count bytes from the stream and store them in dest. See AStream.read for more information on this method.

Returns

The total number of bytes read.

Exceptions raised
AFileStreamReadError
if an error is encountered while attempting to read from the underlying file.

Generated by PasDoc 0.13.0 on 2015-06-23 19:40:11