EndSegment Method

Ends writing the current segment.

Syntax

idocwriter.endSegment([callback])

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 this 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

EndSegment terminates writing the current segment and flushes it to the output stream/file.

You should call EndSegment to close a segment started with StartSegment.

Example IDocWriter Code:

idocwriter1.StartIDoc()
idocwriter1.WriteControlRecord()
idocwriter1.StartSegment("Segment1")
idocwriter1.WriteFieldValue("Field1", "Value1")
idocwriter1.WriteFieldValue("Field2", "Value2")
...
idocwriter1.EndSegment()
idocwriter1.StartSegment("Segment2")
idocwriter1.WriteFieldValue("Field1", "Value1")
...
idocwriter1.EndSegment()
...
idocwriter1.EndIDoc()