ProgressStep Property

Controls the granularity at which the Progress event is fired. Values 0-100.

Syntax

 netcode.getProgressStep([callback])
 netcode.setProgressStep( progressStep, [callback])

Default Value

1

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 getProgressStep([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 setProgressStep([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

This property controls the granularity at which the Progress event is fired. Values 0-100. If this property is not 0, the Progress event will be fired when 0%, n* ProgressStep and 100% of input data is read.

If this property is 0, the Progress event is disabled.

Data Type

Integer