ServicePort Property

A port number for a service. When set, it initiates a search for the corresponding service name and protocol.

Syntax

 ipinfo.getServicePort([callback])
 ipinfo.setServicePort( servicePort, [callback])

Default Value

0

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 getServicePort([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 setServicePort([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 contains the port number for the service specified by ServiceName.

If this property is set to a port number, a search is initiated for the ServiceName and other information related to the service (if any).

The RequestComplete event is fired when the search is complete. RequestId identifies the pending request.

NOTE: This functionality is only available in Windows.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]