Click or drag to resize

FileHelperAsyncEngine Class

Async engine, reads records from file in background, returns them record by record in foreground
Inheritance Hierarchy
SystemObject
  FileHelpersEngineBase
    FileHelpersEventEngineBaseObject
      FileHelpersFileHelperAsyncEngineObject
        FileHelpersFileHelperAsyncEngine

Namespace:  FileHelpers
Assembly:  FileHelpers (in FileHelpers.dll) Version: 3.2.6
Syntax
public sealed class FileHelperAsyncEngine : FileHelperAsyncEngine<Object>

The FileHelperAsyncEngine type exposes the following members.

Constructors
  NameDescription
Public methodFileHelperAsyncEngine(Type)
Initializes a new instance of the FileHelperAsyncEngine class with the specified type of records.
Public methodFileHelperAsyncEngine(Type, Encoding)
Initializes a new instance of the FileHelperAsyncEngine class with the specified type of records.
Top
Properties
  NameDescription
Public propertyEncoding
The encoding to Read and Write the streams. Default is the system's current ANSI code page.
(Inherited from EngineBase.)
Public propertyErrorManager
This is a common class that manages the errors of the library.
(Inherited from EngineBase.)
Public propertyErrorMode
Indicates the behavior of the engine when it finds an error. {Shortcut for )
(Inherited from EngineBase.)
Public propertyFooterText
The Read Footer in the last Read operation. If any.
(Inherited from EngineBase.)
Public propertyHeaderText
The Read Header in the last Read operation. If any.
(Inherited from EngineBase.)
Public propertyItemInt32
Get a field value of the current records.
(Inherited from FileHelperAsyncEngineT.)
Public propertyItemString
Get a field value of the current records.
(Inherited from FileHelperAsyncEngineT.)
Public propertyCode exampleLastRecord (Inherited from FileHelperAsyncEngineT.)
Public propertyLastRecordValues
An array with the values of each field of the current record
(Inherited from FileHelperAsyncEngineT.)
Public propertyLineNumber
The current line number.
(Inherited from EngineBase.)
Public propertyNewLineForWrite
Newline string to be used when engine writes to file. Default is the system's newline setting (System.Environment.NewLine).
(Inherited from EngineBase.)
Public propertyOptions
Allows you to change some record layout options at runtime
(Inherited from EngineBase.)
Public propertyRecordType
Returns the type of records handled by this engine.
(Inherited from EngineBase.)
Public propertyTotalRecords
The total numbers of records in the last read/written file (only works with whole read/write).
(Inherited from EngineBase.)
Top
Methods
  NameDescription
Public methodBeginAppendToFile(String)
Begin the append to an existing file
(Inherited from FileHelperAsyncEngineT.)
Public methodBeginAppendToFile(String, Int32)
Open a file to Append to the end.
(Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleBeginReadFile(String)
Open a specified file and seek to the first record.
(Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleBeginReadFile(String, Int32)
Open a specified file and seek to the first record.
(Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleBeginReadStream
Open a specified stream and seek to the first record.
(Inherited from FileHelperAsyncEngineT.)
Public methodBeginReadString (Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleBeginWriteFile(String)
Open a file to write it. If the file exists the engine will over write it
(Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleBeginWriteFile(String, Int32)
Open a file to write it. If the file exists the engine will over write it
(Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleBeginWriteStream
Set the stream to be used in the WriteNext(T) operation.
(Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleClose
Close all opened stream readers and writers (if any).
(Inherited from FileHelperAsyncEngineT.)
Public methodFlush
Save all the buffered data for write to the disk. Useful to opened async engines that wants to save pending values to disk or for engines used for logging.
(Inherited from FileHelperAsyncEngineT.)
Public methodGetFileHeader
Builds a line with the name of the fields, for a delimited files it uses the same delimiter, for a fixed length field it writes the fields names separated with tabs
(Inherited from EngineBase.)
Public methodCode exampleReadNext
Reads the next record of a file.
(Inherited from FileHelperAsyncEngineT.)
Public methodReadNexts
Reads the specified number of records from a file or stream opened before.
(Inherited from FileHelperAsyncEngineT.)
Public methodReadToEnd
Return array of object for all data to end of the file
(Inherited from FileHelperAsyncEngineT.)
Public methodCode exampleWriteNext
Write the next record to a file or stream opened.
(Inherited from FileHelperAsyncEngineT.)
Public methodWriteNexts
Write the next records to a file or stream opened.
(Inherited from FileHelperAsyncEngineT.)
Public methodWriteNextValues
Write the current record values in the buffer. You can use engine[0] or engine["YourField"] to set the values.
(Inherited from FileHelperAsyncEngineT.)
Top
Events
See Also