XSegmentType Property

Indicates the current segment type.

Syntax

 x12reader.getXSegmentType([callback])

Possible Values

  0 (stNone), 
  1 (stInterchange), 
  2 (stFunctionalGroup), 
  3 (stTransaction), 
  4 (stInterchangeHeader), 
  5 (stFunctionalGroupHeader), 
  6 (stTransactionHeader), 
  7 (stTransactionSegment), 
  8 (stTransactionLoop), 
  9 (stTransactionFooter), 
  10 (stFunctionalGroupFooter), 
  11 (stInterchangeFooter)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getXSegmentType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setXSegmentType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The current segment will be a control segment footer/header or a transaction data segment.

This property is read-only and not available at design time.

Data Type

Integer