MaxSegments Property

The maximum number of occurrences for this segment.

Syntax

 idocwriter.getMaxSegments([callback])

Default Value

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 getMaxSegments([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 setMaxSegments([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 maximum number of occurrences for the current segment type for the IDoc document to be considered valid. This is populated when SegmentIndex is set.

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

Data Type

Integer