Class SwiftReader
The SwiftReader reads SWIFT data from a binary input stream.
Inherited Members
Namespace: Subsembly.Swift
Assembly: Subsembly.Sepa.dll
Syntax
public class SwiftReaderConstructors
SwiftReader(Stream, SwiftOptions)
Creates an SwiftReader reading from the given input stream.
Declaration
public SwiftReader(Stream aInputStream, SwiftOptions nOptions)Parameters
| Type | Name | Description |
|---|---|---|
| Stream | aInputStream | Stream that provides the binary SWIFT data. This must not be null and must be a readable stream. The stream will not be sought, hence it is not required that the stream is seekable. |
| SwiftOptions | nOptions | Flags that control the strictness of the SWIFT parsing. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | The parameter aInputStream was null. |
SwiftReader(TextReader, SwiftOptions)
Creates an SwiftReader reading from the given TextReader.
Declaration
public SwiftReader(TextReader aTextReader, SwiftOptions nOptions)Parameters
| Type | Name | Description |
|---|---|---|
| TextReader | aTextReader | The TextReader to read the SWIFT data from. This must not be null. |
| SwiftOptions | nOptions | Flags that control the strictness of the SWIFT parsing. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | The parameter aTextReader was null. |
SwiftReader(string, SwiftOptions)
Creates an SwiftReader reading from the given text block string.
Declaration
public SwiftReader(string sTextBlock, SwiftOptions nOptions)Parameters
| Type | Name | Description |
|---|---|---|
| string | sTextBlock | String that provides the SWIFT text block data. This must not be null. |
| SwiftOptions | nOptions | Flags that control the strictness of the SWIFT parsing. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | The parameter sTextBlock was null. |
Properties
Encoding
The default encoding of binary SWIFT data.
Declaration
public static Encoding Encoding { get; }Property Value
| Type | Description |
|---|---|
| Encoding |
Gotchas
Indicates which processing options have actually been encountered when parsing the SWIFT input.
Declaration
public SwiftOptions Gotchas { get; }Property Value
| Type | Description |
|---|---|
| SwiftOptions |
Line
Provides the current line number in the SWIFT stream.
Declaration
public int Line { get; }Property Value
| Type | Description |
|---|---|
| int | The very first line of a SWIFT stream has the line number one. The line number is incremented by every CRLF sequence that was encountered in the SWIFT stream. After parsing is complete this property holds the total number of lines. |
MT535_FixApoBank_16SADDINFO16R
Declaration
public bool? MT535_FixApoBank_16SADDINFO16R { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
Options
Flags that control the strictness of the SWIFT parsing.
Declaration
public SwiftOptions Options { get; set; }Property Value
| Type | Description |
|---|---|
| SwiftOptions |
State
Indicates the current state of this SwiftReader instance.
Declaration
public SwiftReaderState State { get; }Property Value
| Type | Description |
|---|---|
| SwiftReaderState |
Methods
ReadField()
Reads the next SWIFT field from the input stream and returns it.
Declaration
public SwiftField ReadField()Returns
| Type | Description |
|---|---|
| SwiftField | Returns a new instance of the SwiftField class that contains the details of the SWIFT field that was read. If the end of the input stream was reached, then null is returned. |
Exceptions
| Type | Condition |
|---|---|
| SwiftException | The input stream did not provide an appropriately formatted SWIFT data stream. |
| IOException | May be thrown by the stream when reading bytes from it. |
| InvalidOperationException | This instance of the SwiftReader is already in one of the final states EndOfStream or Error and cannot continue. |