Reset Method

Resets all the properties of the entire settlement to their default values.

Syntax

tsyssettle.reset([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

This method resets the Header and Parameter Record properties to default values, and clears all Detail Records. To clear only the Detail Records (leaving Header and Parameter records intact) set the DetailRecordCount property to 0.