Click or drag to resize

FileHelperAsyncEngineTBeginReadStream Method

Open a specified stream and seek to the first record.

Namespace:  FileHelpers
Assembly:  FileHelpers (in FileHelpers.dll) Version: 3.2.6
Syntax
Copy
public IDisposable BeginReadStream(
	TextReader reader
)

Parameters

reader
Type: System.IOTextReader
The TextReader of the stream.

Return Value

Type: IDisposable

[Missing <returns> documentation for "M:FileHelpers.FileHelperAsyncEngine`1.BeginReadStream(System.IO.TextReader)"]

Implements

IFileHelperAsyncEngineTBeginReadStream(TextReader)
Remarks

This method only seeks to the first record.

To read record by record use ReadNext method.

When you stop reading the file you must call Close method.

Examples
This example shows a simple example of use of the async methods in the FileHelperAsymcEngine:
Copy
using FileHelpers;

// First declare the record class

[Delimitedrecord("|")]
public class SampleType
{
    public string Field1;
    public int    Field2;
}


public void ReadExample()
{
    SampleType record;    

    var engine = new FileHelperAsyncEngine<SampleType>();

    using(engine.BeginReadFile("source.txt"))
    {
        foreach(var record in engine)
        {

           // put your code here !!!!
           Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());

        }
    }
}
See Also