Class FinSegmentHeader

Internal helper class for SegmentBuffer to access segment header properties.

Inheritance
object
FinSegmentHeader
Inherited Members
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public sealed class FinSegmentHeader

Properties

Number

Returns the segment's number.

Declaration
public string Number { get; }
Property Value
Type Description
string
Remarks

The returned value might be null which means that the corresponding GD was empty or not present. There is also no guarantee that the returned value represents a number/value - it's just the uninterpreted string value.

RefNo

Returns the segment's reference segment number.

Declaration
public string RefNo { get; }
Property Value
Type Description
string
Remarks

The returned value might be null which means that the corresponding GD was empty or not present. There is also no guarantee that the returned value represents a number/value - it's just the uninterpreted string value.

Type

Returns the segment's type.

Declaration
public string Type { get; }
Property Value
Type Description
string
Remarks

The returned value might be null which means that the corresponding GD was empty or not present.

Version

Returns the segment's version.

Declaration
public string Version { get; }
Property Value
Type Description
string
Remarks

The returned value might be null which means that the corresponding GD was empty or not present. There is also no guarantee that the returned value represents a number/value - it's just the uninterpreted string value.

Methods

Scan(byte[], int, int)

Scans and extracts all the segment header information.

Declaration
public static FinSegmentHeader Scan(byte[] vbSegmentBytes, int nOffset, int nLength)
Parameters
Type Name Description
byte[] vbSegmentBytes
int nOffset
int nLength
Returns
Type Description
FinSegmentHeader

Returns a parsed SegmentHeader.
Exceptions
Type Condition
FinParseException

Is thrown, if

  • one of the segment header fields is too long (we have a generous length limit of 16 chars for each field)
  • one of the segment header fields is encoded as a binary element.
  • there's a general problem while scanning the segment.