FileHelperAsyncEngine Class |
Async engine, reads records from file in background,
returns them record by record in foreground
Inheritance HierarchySystemObject
FileHelpersEngineBase
FileHelpersEventEngineBaseObject
FileHelpersFileHelperAsyncEngineObject
FileHelpersFileHelperAsyncEngine
FileHelpersEngineBase
FileHelpersEventEngineBaseObject
FileHelpersFileHelperAsyncEngineObject
FileHelpersFileHelperAsyncEngine
Namespace: FileHelpers
Assembly: FileHelpers (in FileHelpers.dll) Version: 3.2.6
SyntaxThe FileHelperAsyncEngine type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FileHelperAsyncEngine(Type) |
Initializes a new instance of the FileHelperAsyncEngine class with the specified type of records.
|
| FileHelperAsyncEngine(Type, Encoding) |
Initializes a new instance of the FileHelperAsyncEngine class with the specified type of records.
|
Properties| Name | Description | |
|---|---|---|
 | Encoding |
The encoding to Read and Write the streams.
Default is the system's current ANSI code page.
(Inherited from EngineBase.) |
| ErrorManager | This is a common class that manages the errors of the library. (Inherited from EngineBase.) |
| ErrorMode |
Indicates the behavior of the engine when it finds an error.
{Shortcut for )
(Inherited from EngineBase.) |
| FooterText | The Read Footer in the last Read operation. If any. (Inherited from EngineBase.) |
| HeaderText | The Read Header in the last Read operation. If any. (Inherited from EngineBase.) |
| ItemInt32 |
Get a field value of the current records.
(Inherited from FileHelperAsyncEngineT.) |
| ItemString |
Get a field value of the current records.
(Inherited from FileHelperAsyncEngineT.) |
 | LastRecord | Contains the last Record read by the ReadNext method. (Inherited from FileHelperAsyncEngineT.) |
| LastRecordValues |
An array with the values of each field of the current record
(Inherited from FileHelperAsyncEngineT.) |
| LineNumber | The current line number. (Inherited from EngineBase.) |
| NewLineForWrite |
Newline string to be used when engine writes to file.
Default is the system's newline setting (System.Environment.NewLine).
(Inherited from EngineBase.) |
| Options |
Allows you to change some record layout options at runtime
(Inherited from EngineBase.) |
| RecordType | Returns the type of records handled by this engine. (Inherited from EngineBase.) |
| TotalRecords | The total numbers of records in the last read/written file
(only works with whole read/write). (Inherited from EngineBase.) |
Methods| Name | Description | |
|---|---|---|
| BeginAppendToFile(String) |
Begin the append to an existing file
(Inherited from FileHelperAsyncEngineT.) |
| BeginAppendToFile(String, Int32) |
Open a file to Append to the end.
(Inherited from FileHelperAsyncEngineT.) |
| BeginReadFile(String) |
Open a specified file and seek to the first record.
(Inherited from FileHelperAsyncEngineT.) |
| BeginReadFile(String, Int32) |
Open a specified file and seek to the first record.
(Inherited from FileHelperAsyncEngineT.) |
| BeginReadStream |
Open a specified stream and seek to the first record.
(Inherited from FileHelperAsyncEngineT.) |
| BeginReadString | (Inherited from FileHelperAsyncEngineT.) |
| BeginWriteFile(String) |
Open a file to write it.
If the file exists the engine will over write it
(Inherited from FileHelperAsyncEngineT.) |
| BeginWriteFile(String, Int32) |
Open a file to write it.
If the file exists the engine will over write it
(Inherited from FileHelperAsyncEngineT.) |
| BeginWriteStream |
Set the stream to be used in the WriteNext(T) operation.
(Inherited from FileHelperAsyncEngineT.) |
| Close |
Close all opened stream readers and writers (if any).
(Inherited from FileHelperAsyncEngineT.) |
| Flush |
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.) |
| GetFileHeader |
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.) |
| ReadNext |
Reads the next record of a file.
(Inherited from FileHelperAsyncEngineT.) |
| ReadNexts |
Reads the specified number of records from a file or stream opened before.
(Inherited from FileHelperAsyncEngineT.) |
| ReadToEnd |
Return array of object for all data to end of the file
(Inherited from FileHelperAsyncEngineT.) |
| WriteNext |
Write the next record to a file or stream opened.
(Inherited from FileHelperAsyncEngineT.) |
| WriteNexts |
Write the next records to a file or stream opened.
(Inherited from FileHelperAsyncEngineT.) |
| WriteNextValues |
Write the current record values in the buffer. You can use
engine[0] or engine["YourField"] to set the values.
(Inherited from FileHelperAsyncEngineT.) |
Events| Name | Description | |
|---|---|---|
 | AfterReadRecord |
Called in read operations just after the record was created from a
record string.
(Inherited from EventEngineBaseT.) |
| AfterWriteRecord |
Called in write operations just after the record was converted to a
string.
(Inherited from EventEngineBaseT.) |
| BeforeReadRecord |
Called in read operations just before the record string is
translated to a record.
(Inherited from EventEngineBaseT.) |
| BeforeWriteRecord |
Called in write operations just before the record is converted to a
string to write it.
(Inherited from EventEngineBaseT.) |
| Progress | Event handler called to notify progress. (Inherited from EngineBase.) |
See Also