HopErrorDescription Property

The error description for particular hop in the trace.

Syntax

 traceroute.getHopErrorDescription(index, [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 getHopErrorDescription([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 setHopErrorDescription([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 error description for particular hop in the trace.

For a list of valid error codes and their descriptions, please refer to the Error Messages section.

The size of the array is controlled by the HopCount property.

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

Data Type

String