Class SwiftBlock

Represents a single SWIFT Message Block that is part of a SwiftMessage.

Inheritance

object

SwiftBlock

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Subsembly.Swift

Assembly: Subsembly.Sepa.dll

Syntax

public class SwiftBlock

Constructors

SwiftBlock()

Declaration

public SwiftBlock()

SwiftBlock(string, string)

Declaration

public SwiftBlock(string sTag, string sValue)

Parameters

Type	Name	Description
string	sTag
string	sValue

Exceptions

Type	Condition
ArgumentException	The parameter sTag was not `null` and also not a pure alpha numeric string.

Properties

Tag

The tag of this SWIFT Message Block.

Declaration

public string Tag { get; set; }

Property Value

Type	Description
string	This should be one numeric character. However, any string consisting of digits and upper case alphanumeric characters can be used as a Tag.

Exceptions

Type	Condition
ArgumentException	An attempt was made to set a value that is not `null` and also not a pure alpha numeric string.

Value

The value of this SWIFT Message Block.

Declaration

public string Value { get; set; }

Property Value

Type	Description
string

Methods

Read(Stream, int)

Reads a single SWIFT Message Block from an input stream.

Declaration

public int Read(Stream aInputStream, int nMaxBytes)

Parameters

Type	Name	Description
Stream	aInputStream	The Stream to read the data from.
int	nMaxBytes	The maximum number of bytes to read from the stream. Use Int32.MaxValue if you do not want to impose any limit. If this is zero, then this method will simply clear this instance.

Returns

Type	Description
int	Returns the actual number of bytes that have been consumed from the input stream. If the input stream was already at the EOF position when this method was called, then zero is returned. If the parameter nMaxBytes was zero, then this method immediately returns zero, too.

Exceptions

Type	Condition
ArgumentNullException	The parameter aInputStream was `null`.
ArgumentOutOfRangeException	The parameter nMaxBytes was negative.
SwiftException	The input data was not a valid SWIFT Block structure.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()