AdapterStatus Property
Returns the current status of the adapter.
Syntax
ipinfo.getAdapterStatus([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 getAdapterStatus([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 setAdapterStatus([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 proprety holds the current status of the adapter specified by AdapterIndex.
Possible values are as follows:
- "Up"
- "Down"
- "Testing"
- "Unknown"
- "Dormant"
- "NotPresent"
- "LowerLayerDown"
This property is not applicable when UseOldApi is true.
This property is read-only.
Data Type
String