FileHelperEngine Class

One of the main classes of the library.

This engine is responsable to Read/Write the records at once from/to files or streams.

You can use the DelimitedFileEngine or the FixedFileEngine if you need to change some options at runtime

For a list of all members of this type, see FileHelperEngine Members.

System.Object
   FileHelpers.EngineBase
      FileHelpers.FileHelperEngine
         FileHelpers.CsvEngine
         FileHelpers.DelimitedFileEngine
         FileHelpers.FixedFileEngine

Remarks

You can set the ErrorMode of this class when found an error, and can retrive them with the Errors property.

See in the Class Diagram and in the Quick Start Guide for more Info.

Or you can browse the Examples Seccion for more code.

Engines Diagram:

Example

This example show the basic use of the library with minimun code:

    using FileHelpers;
    
    // First declare the record class
        
    [Delimitedrecord("|")]
    public class SampleType
    {
        public string Field1;
        public int    Field2;
    }


    public void ReadExample()
    {
        FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

        SampleType[] records;    
        
        records = (SampleType[]) engine.ReadFile("source.txt");
        
        // Now "records" array contains all the records in the
        // sourcefile and can be acceded like this:
        
        int sum = records[0].Field2 + records[1].Field2;
    }

    
    public void WriteExample()
    {
        FileHelperEngine engine = new FileHelperEngine(typeof(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
        
    }

Requirements

Namespace: FileHelpers

Assembly: FileHelpers (in FileHelpers.dll)

See Also

FileHelperEngine Members | FileHelpers Namespace | Quick Start Guide | Class Diagram | Examples of Use | Attributes List

---

Powered by: