C# Class SharpTune.RomMod.SRecordReader

Reads SRecord objects from an SRecord file.
Inheritance: IDisposable
Show file Open project: Merp/SharpTune Class Usage Examples

Public Methods

Method Description
Dispose ( ) : void

Disposes the underlying StreamReader.

Open ( ) : void

Open the file reader.

Reset ( ) : void

Close and re-open the reader.

SRecordReader ( Stream stream, string path ) : System
SRecordReader ( string path ) : System

Constructor.

TryReadNextRecord ( SRecord &record ) : bool

Read the next record from an SRecord file.

Private Methods

Method Description
GetByte ( string record, int &index, int &checksum ) : byte

Get a single byte from an SRecord row.

Method Details

Dispose() public method

Disposes the underlying StreamReader.
public Dispose ( ) : void
return void

Open() public method

Open the file reader.
public Open ( ) : void
return void

Reset() public method

Close and re-open the reader.
public Reset ( ) : void
return void

SRecordReader() public method

public SRecordReader ( Stream stream, string path ) : System
stream Stream
path string
return System

SRecordReader() public method

Constructor.
public SRecordReader ( string path ) : System
path string
return System

TryReadNextRecord() public method

Read the next record from an SRecord file.
public TryReadNextRecord ( SRecord &record ) : bool
record SRecord
return bool