Click or drag to resize

IFileHelperEngineTWriteStream Method (TextWriter, IEnumerableT)

Write an array of records to the specified Stream.

Namespace:  FileHelpers
Assembly:  FileHelpers (in FileHelpers.dll) Version: 3.2.6
Syntax
Copy
void WriteStream(
	TextWriter writer,
	IEnumerable<T> records
)

Parameters

writer
Type: System.IOTextWriter
The writer of the source stream.
records
Type: System.Collections.GenericIEnumerableT
The records to write (Can be an array, ArrayList, etc)

Return Value

Type: 
True if the operation is successful. False otherwise.
Remarks
This method only uses the stream and don't close them after use it, you must do it.
Examples
This example shows a simple example of use of the library with a minimum of code:
Copy
using FileHelpers;

// First declare the record class

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


public void WriteExample()
{
    var engine = new FileHelperEngine<SampleType>();

    SampleType[] records = new SampleType[1];

    records[0] = new SampleType();

    records[0].Field1 = "Hello World";
    records[0].Field2 = 12;

    engine.WriteFile("destination.txt", records);

    // Now the file contains the created record in this format:
    // 
    // Hello World,12

}
See Also