IPInfo Class

Properties   Methods   Events   Config Settings   Errors  

The IPInfo class is used to resolve host names to host addresses and vice versa using an asynchronous DNS. The class provides access to other Transmission Control Protocol (TCP)/IP database functions as well.

Class Name

IPWorks_IPInfo

Procedural Interface

 ipworks_ipinfo_open();
 ipworks_ipinfo_close($res);
 ipworks_ipinfo_register_callback($res, $id, $function);
 ipworks_ipinfo_get_last_error($res);
 ipworks_ipinfo_get_last_error_code($res);
 ipworks_ipinfo_set($res, $id, $index, $value);
 ipworks_ipinfo_get($res, $id, $index);
 ipworks_ipinfo_do_config($res, $configurationstring);
 ipworks_ipinfo_do_dhcprelease($res);
 ipworks_ipinfo_do_dhcprenew($res);
 ipworks_ipinfo_do_displaydnscache($res);
 ipworks_ipinfo_do_doevents($res);
 ipworks_ipinfo_do_flushdnscache($res);
 ipworks_ipinfo_do_getmac($res, $ipaddress);
 ipworks_ipinfo_do_reset($res);
 ipworks_ipinfo_do_resolveaddress($res, $hostaddress);
 ipworks_ipinfo_do_resolvename($res, $hostname);

Remarks

The IPInfo class operates asynchronously. Requests are posted to the class by setting a property like HostName or HostAddress and then waiting for the RequestComplete event. The RequestId property identifies the request.

Up to 100 simultaneous requests can be queued at any moment. PendingRequests shows the number of pending requests and also may be used to adjust the size of the queue (by dumping a number of the pending requests).

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AdapterBroadcastAddressThis property includes the broadcast address of the adapter.
AdapterCountThis property includes the number of adapters in the system.
AdapterDescriptionThis property includes the description of the adapter identified by AdapterIndex .
AdapterDeviceIndexThis property includes the system index of the adapter identified by AdapterIndex .
AdapterDHCPEnabledThis property shows whether or not the adapter identified by AdapterIndex has been DHCP enabled.
AdapterDHCPServerThis property includes the DHCP server of the adapter identified by AdapterIndex .
AdapterDNSServersThis property includes the DNS server list for the adapter identified by AdapterIndex .
AdapterGatewayThis property includes the default gateway of the adapter identified by AdapterIndex .
AdapterIndexThis property sets the current adapter.
AdapterIPAddressThis property includes the IP address of the adapter identified by AdapterIndex .
AdapterIPv6AddressThis is the IPv6 address of the adapter identified by AdapterIndex .
AdapterIPv6LinkLocalAddressThis property includes the IPv6 link to the local address of the adapter identified by AdapterIndex .
AdapterLeaseExpiresThis property includes the expiration date and time of the lease obtained by the adapter identified by AdapterIndex .
AdapterLeaseObtainedThis property includes the date and time when the current lease was obtained by the adapter identified by AdapterIndex .
AdapterNameThis property includes the name of the adapter identified by AdapterIndex .
AdapterOtherIPAddressesThis property includes the other IP addresses leased by the adapter specified by AdapterIndex , if any.
AdapterPhysicalAddressThis property includes the physical address of the adapter identified by AdapterIndex .
AdapterPrimaryWINSServerThis property includes the primary WINS server of the adapter identified by AdapterIndex .
AdapterSecondaryWINSServerThis property includes the secondary WINS server of the adapter identified by AdapterIndex .
AdapterStatusThis property returns the current status of the adapter.
AdapterSubnetMaskThis property includes the subnet of the adapter identified by AdapterIndex .
AdapterTypeThis property includes the type of adapter identified by AdapterIndex .
AdapterUsesWINSThis property includes the shows whether or not the adapter identified by AdapterIndex uses WINS.
AdapterZoneIdThis property includes the zone Id of the adapter identified by AdapterIndex .
ARPProxyThis property shows whether the local computer is acting as an Address Resolution Protocol (ARP) proxy.
DHCPScopeThis property includes the DHCP scope of the DHCP server.
DNSEnabledThis property shows whether DNS is enabled on the local computer.
DNSServerThis property includes the address of the DNS server.
DomainNameThis property includes the current network domain on which the system resides.
HostAddressThis property includes an internet address in dotted format. When set, it initiates a search for the corresponding host name.
HostAliasesThis property includes other names corresponding to the host with the name HostName.
HostNameThis property includes the domain name of an internet host. When set, it initiates a search for the corresponding address(es).
LocalHostThis property includes the name of the local host.
NodeTypeThis property includes the type of node for the system.
OtherAddressesThis property includes other addresses for the host identified by HostName (for multihomed hosts).
OtherDNSServersThis property includes other DNS servers configured for the host machine.
PendingRequestsThis property includes the number of requests awaiting completion.
RequestIdThis property includes the handle of the last request.
RoutingEnabledThis property shows whether routing is enabled on the local computer.
ServiceAliasesThis property includes other names by which the service specified by ServiceName / ServicePort is known.
ServiceNameThis property includes the name for a service. When set, it initiates a search for the corresponding port number and protocol.
ServicePortThis property includes a port number for a service. When set, it initiates a search for the corresponding service name and protocol.
ServiceProtocolThis property includes the protocol of the service specified by ServiceName / ServicePort .

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DHCPReleaseThis method releases the IP address of the current adapter specified by AdapterIndex .
DHCPRenewThis method renews the IP address of the current adapter specified by AdapterIndex .
DisplayDNSCacheThis method displays cached DNS entries.
DoEventsThis method processes events from the internal message queue.
FlushDNSCacheThis method flushes the DNS cache.
GetMACThis method returns the MAC address of the network interface at IPAddress .
ResetThis method resets the class, stopping all pending requests and refreshing network information.
ResolveAddressThis method resolves an IP address.
ResolveNameThis method resolves a host name.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

DNSCacheEntryThis event fires once for each cached DNS entry.
ErrorFired when information is available about errors during data delivery.
RequestCompleteThis event is fired after an asynchronous request completes.

Config Settings


The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AdapterDADStateSpecifies the Duplicate Address Detection state of the IP address of the adapter specified by AdapterIndex.
AdapterIPv6DADStateSpecifies the Duplicate Address Detection state of the IPv6 address of the adapter specified by AdapterIndex.
AdapterOtherDADStatesSpecifies the Duplicate Address Detection states of the IP addresses leased by the adapter specified by AdapterIndex, if any.
ARPAddressSpecifies the IP Address of the interface to be used for the GetMAC method.
UseOldApiIf set the class will use the old API to get Adapter information.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AdapterBroadcastAddress Property (IPWorks_IPInfo Class)

This property includes the broadcast address of the adapter.

Object Oriented Interface


public function getAdapterBroadcastAddress();


Procedural Interface


ipworks_ipinfo_get($res, 1 );


Default Value

''

Remarks

This property contains the broadcast address of the adapter specified by AdapterIndex.

This property is read-only.

Data Type

String

AdapterCount Property (IPWorks_IPInfo Class)

This property includes the number of adapters in the system.

Object Oriented Interface


public function getAdapterCount();


Procedural Interface


ipworks_ipinfo_get($res, 2 );


Default Value

0

Remarks

This property shows how many adapters are installed in the system. You can set the AdapterIndex from 0 to the AdapterCount and then examine the adapter properties, such as AdapterDescription, AdapterName, and AdapterIPAddress, to retrieve information about each adapter.

This property is read-only.

Data Type

Integer

AdapterDescription Property (IPWorks_IPInfo Class)

This property includes the description of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterDescription();


Procedural Interface


ipworks_ipinfo_get($res, 3 );


Default Value

''

Remarks

This property contains the description of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterDeviceIndex Property (IPWorks_IPInfo Class)

This property includes the system index of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterDeviceIndex();


Procedural Interface


ipworks_ipinfo_get($res, 4 );


Default Value

0

Remarks

This property contains the system index of the adapter identified by AdapterIndex, as returned by the system.

This property is read-only.

Data Type

Integer

AdapterDHCPEnabled Property (IPWorks_IPInfo Class)

This property shows whether or not the adapter identified by AdapterIndex has been DHCP enabled.

Object Oriented Interface


public function getAdapterDHCPEnabled();


Procedural Interface


ipworks_ipinfo_get($res, 5 );


Default Value

false

Remarks

This property indicates whether or not the adapter identified by AdapterIndex has been DHCP enabled. The Dynamic Host Configuration Protocol (DHCP) is used to automatically assign IP addresses on a network.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

AdapterDHCPServer Property (IPWorks_IPInfo Class)

This property includes the DHCP server of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterDHCPServer();


Procedural Interface


ipworks_ipinfo_get($res, 6 );


Default Value

''

Remarks

This property contains the DHCP server of the adapter identified by AdapterIndex. The Dynamic Host Configuration Protocol (DHCP) is used to automatically assign IP addresses on a network.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterDNSServers Property (IPWorks_IPInfo Class)

This property includes the DNS server list for the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterDNSServers();


Procedural Interface


ipworks_ipinfo_get($res, 7 );


Default Value

''

Remarks

This property contains a space-separated list of DNS servers for the adapter specified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterGateway Property (IPWorks_IPInfo Class)

This property includes the default gateway of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterGateway();


Procedural Interface


ipworks_ipinfo_get($res, 8 );


Default Value

''

Remarks

This property contains the default gateway of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterIndex Property (IPWorks_IPInfo Class)

This property sets the current adapter.

Object Oriented Interface


public function getAdapterIndex();


public function setAdapterIndex($value);

Procedural Interface


ipworks_ipinfo_get($res, 9 );


ipworks_ipinfo_set($res, 9, $value );

Default Value

0

Remarks

When this property is set, the class asks the system for information on the adapter with an index of AdapterIndex. If the system has information, the adapter properties will be populated with the data returned.

AdapterCount is the number of adapters located in the system.

Data Type

Integer

AdapterIPAddress Property (IPWorks_IPInfo Class)

This property includes the IP address of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterIPAddress();


Procedural Interface


ipworks_ipinfo_get($res, 10 );


Default Value

''

Remarks

This property contains the IP address of the adapter identified by AdapterIndex, as returned by the system.

This property is read-only.

Data Type

String

AdapterIPv6Address Property (IPWorks_IPInfo Class)

This is the IPv6 address of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterIPv6Address();


Procedural Interface


ipworks_ipinfo_get($res, 11 );


Default Value

''

Remarks

This is the IPv6 address of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

Note: This functionality is available only on XP or newer OS versions.

This property is read-only.

Data Type

String

AdapterIPv6LinkLocalAddress Property (IPWorks_IPInfo Class)

This property includes the IPv6 link to the local address of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterIPv6LinkLocalAddress();


Procedural Interface


ipworks_ipinfo_get($res, 12 );


Default Value

''

Remarks

This property includes the IPv6 link to the local address of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterLeaseExpires Property (IPWorks_IPInfo Class)

This property includes the expiration date and time of the lease obtained by the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterLeaseExpires();


Procedural Interface


ipworks_ipinfo_get($res, 13 );


Default Value

''

Remarks

This property contains the expiration date and time of the lease obtained by the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterLeaseObtained Property (IPWorks_IPInfo Class)

This property includes the date and time when the current lease was obtained by the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterLeaseObtained();


Procedural Interface


ipworks_ipinfo_get($res, 14 );


Default Value

''

Remarks

This property contains the date and time when the current lease was obtained by the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterName Property (IPWorks_IPInfo Class)

This property includes the name of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterName();


Procedural Interface


ipworks_ipinfo_get($res, 15 );


Default Value

''

Remarks

This property contains the name of the adapter identified by AdapterIndex, as returned by the system.

This property is read-only.

Data Type

String

AdapterOtherIPAddresses Property (IPWorks_IPInfo Class)

This property includes the other IP addresses leased by the adapter specified by AdapterIndex , if any.

Object Oriented Interface


public function getAdapterOtherIPAddresses();


Procedural Interface


ipworks_ipinfo_get($res, 16 );


Default Value

''

Remarks

This property contains a space-separated list of any other IP addresses leased by the adapter specified by AdapterIndex, if any.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterPhysicalAddress Property (IPWorks_IPInfo Class)

This property includes the physical address of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterPhysicalAddress();


Procedural Interface


ipworks_ipinfo_get($res, 17 );


Default Value

''

Remarks

This property contains the physical address of the adapter identified by AdapterIndex, as returned from the system.

Note: This property is not supported in MacOS or iOS.

This property is read-only.

Data Type

String

AdapterPrimaryWINSServer Property (IPWorks_IPInfo Class)

This property includes the primary WINS server of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterPrimaryWINSServer();


Procedural Interface


ipworks_ipinfo_get($res, 18 );


Default Value

''

Remarks

This property contains the primary WINS server of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterSecondaryWINSServer Property (IPWorks_IPInfo Class)

This property includes the secondary WINS server of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterSecondaryWINSServer();


Procedural Interface


ipworks_ipinfo_get($res, 19 );


Default Value

''

Remarks

This property contains the secondary WINS server of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterStatus Property (IPWorks_IPInfo Class)

This property returns the current status of the adapter.

Object Oriented Interface


public function getAdapterStatus();


Procedural Interface


ipworks_ipinfo_get($res, 20 );


Default Value

''

Remarks

This property holds the current status of the adapter specified by AdapterIndex.

Possible values are as follows:

  • "Up"
  • "Down"
  • "Testing"
  • "Unknown"
  • "Dormant"
  • "NotPresent"
  • "LowerLayerDown"

Note: This property is not applicable when UseOldApi is True.

This property is read-only.

Data Type

String

AdapterSubnetMask Property (IPWorks_IPInfo Class)

This property includes the subnet of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterSubnetMask();


Procedural Interface


ipworks_ipinfo_get($res, 21 );


Default Value

''

Remarks

This property contains the subnet of the adapter identified by AdapterIndex, as returned by the system.

This property is read-only.

Data Type

String

AdapterType Property (IPWorks_IPInfo Class)

This property includes the type of adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterType();


Procedural Interface


ipworks_ipinfo_get($res, 22 );


Default Value

''

Remarks

This property contains the type of adapter identified by AdapterIndex, as returned by the system.

Possible values include the following:

OTHEROther
ETHERNETEthernet
TOKENRINGToken Ring
FDDIFiber Distributed Data Interface
PPPPoint-to-Point Protocol
LOOPBACKLoopback
SLIPSerial Line Internet Protocol

Possible values include the following (Unix OS):

UPInterface is up
BROADCASTBroadcast address is valid
DEBUGTurn on debugging
LOOPBACKInterface is a loopback device
POINTOPOINTInterface is a point-to-point link
RUNNINGResources allocated
NOARPNo address resolution protocol
PROMISCReceive all packets
NOTRAILERSAvoid use of trailers
ALLMULTIReceive all multicast packets
MASTERMaster of a load balancer
SLAVESlave of a load balancer
MULTICASTSupports multicast
PORTSELCan set media type
AUTOMEDIAAuto media select active
DYNAMICDialup device with dynamic addresses

This property is read-only.

Data Type

String

AdapterUsesWINS Property (IPWorks_IPInfo Class)

This property includes the shows whether or not the adapter identified by AdapterIndex uses WINS.

Object Oriented Interface


public function getAdapterUsesWINS();


Procedural Interface


ipworks_ipinfo_get($res, 23 );


Default Value

false

Remarks

This property indicates whether or not the adapter identified by AdapterIndex uses WINS. Windows Internet Name Service (WINS) is a name resolution service that is used to resolve Windows network hostnames to IP addresses.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

AdapterZoneId Property (IPWorks_IPInfo Class)

This property includes the zone Id of the adapter identified by AdapterIndex .

Object Oriented Interface


public function getAdapterZoneId();


Procedural Interface


ipworks_ipinfo_get($res, 24 );


Default Value

0

Remarks

Also known as a scope Id, the zone Id specifies the IPv6 zone to which the current adapter belongs. The values of the zone Id are defined relative to the sending host. When using an IPv6-enabled XP operating system, the zone Id of the sender MUST be appended after a "%" to the desired IPv6 address. This is an integer value on Windows systems.

Note: This functionality is only available in Windows.

Note: This functionality is only available on XP or newer OS versions.

This property is read-only.

Data Type

Integer

ARPProxy Property (IPWorks_IPInfo Class)

This property shows whether the local computer is acting as an Address Resolution Protocol (ARP) proxy.

Object Oriented Interface


public function getARPProxy();


Procedural Interface


ipworks_ipinfo_get($res, 25 );


Default Value

false

Remarks

This property indicates whether the local computer is acting as an ARP proxy. If True, the local computer will act as an ARP proxy and will respond to ARP requests with its own hardware address.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

DHCPScope Property (IPWorks_IPInfo Class)

This property includes the DHCP scope of the DHCP server.

Object Oriented Interface


public function getDHCPScope();


Procedural Interface


ipworks_ipinfo_get($res, 26 );


Default Value

''

Remarks

This property contains a range of IP addresses that the Dynamic Host Configuration Protocol (DHCP) server can lease to clients.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

DNSEnabled Property (IPWorks_IPInfo Class)

This property shows whether DNS is enabled on the local computer.

Object Oriented Interface


public function getDNSEnabled();


Procedural Interface


ipworks_ipinfo_get($res, 27 );


Default Value

false

Remarks

This property indicates whether DNS is enabled on the local computer. If True, DNS is enabled, and name resolution will be available.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

DNSServer Property (IPWorks_IPInfo Class)

This property includes the address of the DNS server.

Object Oriented Interface


public function getDNSServer();


Procedural Interface


ipworks_ipinfo_get($res, 28 );


Default Value

''

Remarks

The class attempts to find the default DNS server for the machine where it is installed, and to provide it in this property.

If the class cannot determine the default DNS server address, this property value will be an empty string.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

DomainName Property (IPWorks_IPInfo Class)

This property includes the current network domain on which the system resides.

Object Oriented Interface


public function getDomainName();


Procedural Interface


ipworks_ipinfo_get($res, 29 );


Default Value

''

Remarks

This property contains the domain name to which the system is joined.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

HostAddress Property (IPWorks_IPInfo Class)

This property includes an internet address in dotted format. When set, it initiates a search for the corresponding host name.

Object Oriented Interface


public function getHostAddress();


public function setHostAddress($value);

Procedural Interface


ipworks_ipinfo_get($res, 30 );


ipworks_ipinfo_set($res, 30, $value );

Default Value

''

Remarks

This property contains the IP address (in internet dotted format aaa.bbb.ccc.ddd) of the host whose domain name is specified by HostName

If HostAddress is set to an IP address, a search is initiated for the corresponding host names(s).

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

Example. Resolve an Address:

IPInfoControl.HostAddress = "10.0.1.10" While IPInfoControl.PendingRequests > 0 IPInfoControl.DoEvents() End While ResolvedName = IPInfoControl.HostName

Data Type

String

HostAliases Property (IPWorks_IPInfo Class)

This property includes other names corresponding to the host with the name HostName.

Object Oriented Interface


public function getHostAliases();


Procedural Interface


ipworks_ipinfo_get($res, 31 );


Default Value

''

Remarks

This property contains a list of alternate names for the host specified by HostName and HostAddress separated by spaces.

This property is read-only.

Data Type

String

HostName Property (IPWorks_IPInfo Class)

This property includes the domain name of an internet host. When set, it initiates a search for the corresponding address(es).

Object Oriented Interface


public function getHostName();


public function setHostName($value);

Procedural Interface


ipworks_ipinfo_get($res, 32 );


ipworks_ipinfo_set($res, 32, $value );

Default Value

''

Remarks

This property contains the domain name of the host whose IP address is specified by HostAddress.

If this property is set to a domain name, a search is initiated for the corresponding host address(s).

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

Example. Resolve a Name:

IPInfoControl.HostName = "MyHostName" While IPInfoControl.PendingRequests > 0 IPInfoControl.DoEvents() End While ResolvedAddress = IPInfoControl.HostAddress

Data Type

String

LocalHost Property (IPWorks_IPInfo Class)

This property includes the name of the local host.

Object Oriented Interface


public function getLocalHost();


Procedural Interface


ipworks_ipinfo_get($res, 33 );


Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call. If the user has assigned an IP address, it will contain the value of that address.

This property is read-only.

Data Type

String

NodeType Property (IPWorks_IPInfo Class)

This property includes the type of node for the system.

Object Oriented Interface


public function getNodeType();


Procedural Interface


ipworks_ipinfo_get($res, 34 );


Default Value

''

Remarks

This property contains the type of node for the system. Possible values include BROADCAST, PEERTOPEER, MIXED, and HYBRID.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

OtherAddresses Property (IPWorks_IPInfo Class)

This property includes other addresses for the host identified by HostName (for multihomed hosts).

Object Oriented Interface


public function getOtherAddresses();


Procedural Interface


ipworks_ipinfo_get($res, 35 );


Default Value

''

Remarks

This property contains a list of alternate addresses for the host specified by HostName and HostAddress separated by spaces. Most hosts have only one IP interface. This property is useful when querying multihomed hosts (hosts with more than one interface).

This property is read-only.

Data Type

String

OtherDNSServers Property (IPWorks_IPInfo Class)

This property includes other DNS servers configured for the host machine.

Object Oriented Interface


public function getOtherDNSServers();


Procedural Interface


ipworks_ipinfo_get($res, 36 );


Default Value

''

Remarks

This property contains a space-separated list of DNS servers configured for the host machine. Note: The primary server is provided in the DNSServer property.

Note: This functionality is only available in Windows.

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

Data Type

String

PendingRequests Property (IPWorks_IPInfo Class)

This property includes the number of requests awaiting completion.

Object Oriented Interface


public function getPendingRequests();


public function setPendingRequests($value);

Procedural Interface


ipworks_ipinfo_get($res, 37 );


ipworks_ipinfo_set($res, 37, $value );

Default Value

0

Remarks

This property serves two functions: it shows the number of requests that are pending completion, and it also can be used to adjust the size of the queue by dumping part or all of the pending requests.

To cancel all the pending requests at any moment, simply set PendingRequests to 0.

Note: This functionality is only available in Windows.

Data Type

Integer

RequestId Property (IPWorks_IPInfo Class)

This property includes the handle of the last request.

Object Oriented Interface


public function getRequestId();


Procedural Interface


ipworks_ipinfo_get($res, 38 );


Default Value

0

Remarks

This property contains the handle of the last request.

This handle can be used later to identify the request when the RequestComplete event is fired.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Integer

RoutingEnabled Property (IPWorks_IPInfo Class)

This property shows whether routing is enabled on the local computer.

Object Oriented Interface


public function getRoutingEnabled();


Procedural Interface


ipworks_ipinfo_get($res, 39 );


Default Value

false

Remarks

This property indicates whether routing is enabled on the local computer.

Note: This functionality is only available in Windows.

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

Data Type

Boolean

ServiceAliases Property (IPWorks_IPInfo Class)

This property includes other names by which the service specified by ServiceName / ServicePort is known.

Object Oriented Interface


public function getServiceAliases();


Procedural Interface


ipworks_ipinfo_get($res, 40 );


Default Value

''

Remarks

This property contains a list of alternate service names separated by spaces. In most cases, this list is empty.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

ServiceName Property (IPWorks_IPInfo Class)

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

Object Oriented Interface


public function getServiceName();


public function setServiceName($value);

Procedural Interface


ipworks_ipinfo_get($res, 41 );


ipworks_ipinfo_set($res, 41, $value );

Default Value

''

Remarks

This property contains the name of the specified service located at ServicePort.

If this property is set to a service name, a search is initiated for the corresponding ServicePort 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

String

ServicePort Property (IPWorks_IPInfo Class)

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

Object Oriented Interface


public function getServicePort();


public function setServicePort($value);

Procedural Interface


ipworks_ipinfo_get($res, 42 );


ipworks_ipinfo_set($res, 42, $value );

Default Value

0

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

ServiceProtocol Property (IPWorks_IPInfo Class)

This property includes the protocol of the service specified by ServiceName / ServicePort .

Object Oriented Interface


public function getServiceProtocol();


public function setServiceProtocol($value);

Procedural Interface


ipworks_ipinfo_get($res, 43 );


ipworks_ipinfo_set($res, 43, $value );

Default Value

''

Remarks

This property contains the protocol for the service specified by ServiceName.

Setting this property to a particular protocol name (e.g., 'udp' or 'tcp') will force a search for a service for that protocol only. If this property is set to "" (empty string), then the first entry for the service will be returned and this property will be set to the corresponding protocol.

Note: This functionality is only available in Windows.

Data Type

String

Config Method (IPWorks_IPInfo Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_ipinfo_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DHCPRelease Method (IPWorks_IPInfo Class)

This method releases the IP address of the current adapter specified by AdapterIndex .

Object Oriented Interface

public function doDHCPRelease();

Procedural Interface

ipworks_ipinfo_do_dhcprelease($res);

Remarks

This method releases the IP address of the current adapter specified by AdapterIndex. If AdapterDHCPEnabled is True, the lease of the IP address assigned to the current adapter specified by AdapterIndex is released.

Note: This functionality is only available in Windows.

DHCPRenew Method (IPWorks_IPInfo Class)

This method renews the IP address of the current adapter specified by AdapterIndex .

Object Oriented Interface

public function doDHCPRenew();

Procedural Interface

ipworks_ipinfo_do_dhcprenew($res);

Remarks

This method renews the IP address of the current adapter specified by AdapterIndex. If AdapterDHCPEnabled is True, the lease of the IP address assigned to the current adapter specified by AdapterIndex is renewed.

Note: This functionality is only available in Windows.

DisplayDNSCache Method (IPWorks_IPInfo Class)

This method displays cached DNS entries.

Object Oriented Interface

public function doDisplayDNSCache();

Procedural Interface

ipworks_ipinfo_do_displaydnscache($res);

Remarks

This method displays details of the locally cached DNS records.

This method will return a string with information about the DNS cache. In addition the DNSCacheEntry event will fire once per cached entry.

The returned value is in the following format:

docs.google.com
----------------------------------------
Record Name . . . . . : docs.google.com
Record Type . . . . . : 1(A)
Time To Live  . . . . : 48
Data Length . . . . . : 4
Section . . . . . . . : Answer
A Record  . . . . . . : 216.58.218.238

Note: This functionality is only available in Windows.

DoEvents Method (IPWorks_IPInfo Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_ipinfo_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

FlushDNSCache Method (IPWorks_IPInfo Class)

This method flushes the DNS cache.

Object Oriented Interface

public function doFlushDNSCache();

Procedural Interface

ipworks_ipinfo_do_flushdnscache($res);

Remarks

This method flushes the DNS cache for the system.

Note: This functionality is only available in Windows.

GetMAC Method (IPWorks_IPInfo Class)

This method returns the MAC address of the network interface at IPAddress .

Object Oriented Interface

public function doGetMAC($ipaddress);

Procedural Interface

ipworks_ipinfo_do_getmac($res, $ipaddress);

Remarks

This method returns the unique Media Access Control (MAC) address of the network interface at IPAddress.

Note: This functionality is only available in Windows.

Reset Method (IPWorks_IPInfo Class)

This method resets the class, stopping all pending requests and refreshing network information.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_ipinfo_do_reset($res);

Remarks

This method resets the class, stopping all pending requests and refreshing network information. If the network configuration has changed, call this method to retrieve the latest information.

ResolveAddress Method (IPWorks_IPInfo Class)

This method resolves an IP address.

Object Oriented Interface

public function doResolveAddress($hostaddress);

Procedural Interface

ipworks_ipinfo_do_resolveaddress($res, $hostaddress);

Remarks

This method resolves the IP address HostAddress and sets HostName to the name of the host corresponding to HostAddress.

Calling this method is equivalent to setting the HostAddress property to HostAddress.

Example. Resolve an Address:

IPInfoControl.ResolveAddress ("10.0.1.10") While (IPInfoControl.PendingRequests > 0) IPInfoControl.DoEvents Wend Debug.Print IPInfoControl.HostName

ResolveName Method (IPWorks_IPInfo Class)

This method resolves a host name.

Object Oriented Interface

public function doResolveName($hostname);

Procedural Interface

ipworks_ipinfo_do_resolvename($res, $hostname);

Remarks

This method resolves the host name HostName and sets HostAddress to the IP address of the host corresponding to HostName.

Calling this method is equivalent to setting the HostName property to HostName.

Example. Resolve a Name:

IPInfoControl.ResolveName ("MyHostName") While (IPInfoControl.PendingRequests > 0) IPInfoControl.DoEvents Wend Debug.Print IPInfoControl.HostAddress

DNSCacheEntry Event (IPWorks_IPInfo Class)

This event fires once for each cached DNS entry.

Object Oriented Interface

public function fireDNSCacheEntry($param);

Procedural Interface

ipworks_ipinfo_register_callback($res, 1, array($this, 'fireDNSCacheEntry'));

Parameter List

 'recordname'
'recordtype'
'timetolive'
'datalength'
'section'
'recordvalue'
'recordinfo'

Remarks

This event fires once for each entry in the local DNS cache when DisplayDNSCache is called.

RecordName is the host name to which the record applies.

RecordType is the type of response. For instance 1 is an A record.

TimeToLive is the time in seconds after which the cached entry expires.

DataLength is the length of the data in bytes. For instance, if the RecordType is A and an IPv4 address is cached, its DataLength would be 4. CNAME and PTR records will contain the length of the address in memory where the value is held.

Section is the section of the DNS response from which the record is taken. Most commonly, this is the "Answer" section.

RecordValue is the actual value that is cached. For instance this may be an IP address for A records.

RecordInfo is a text representation of the other parameters. This is suitable for use in a log file or to display.

Error Event (IPWorks_IPInfo Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_ipinfo_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

RequestComplete Event (IPWorks_IPInfo Class)

This event is fired after an asynchronous request completes.

Object Oriented Interface

public function fireRequestComplete($param);

Procedural Interface

ipworks_ipinfo_register_callback($res, 3, array($this, 'fireRequestComplete'));

Parameter List

 'requestid'
'statuscode'
'description'

Remarks

The RequestId parameter specifies the request that just completed. The class properties that relate to this request are completed with the returned values. For example, in the case of domain name resolution, HostName, HostAddress, HostAliases, and OtherAddresses are set to the resolved values.

If the request completed normally, StatusCode is 0, and Description is "OK". If not, StatusCode has the error code returned by the system. Description contains a description of this code.

Please refer to the Error Codes section for more information.

Note: This functionality is only available in Windows.

Config Settings (IPInfo Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

IPInfo Config Settings

AdapterDADState:   Specifies the Duplicate Address Detection state of the IP address of the adapter specified by AdapterIndex.

The possible values are as follows:

  • (Empty) - Indicates the class was unable to get any information.
  • Invalid
  • Tentative
  • Duplicate
  • Deprecated
  • Preferred
AdapterIPv6DADState:   Specifies the Duplicate Address Detection state of the IPv6 address of the adapter specified by AdapterIndex.

The possible values are as follows:

  • (Empty) - Indicates the class was unable to get any information.
  • Invalid
  • Tentative
  • Duplicate
  • Deprecated
  • Preferred
AdapterOtherDADStates:   Specifies the Duplicate Address Detection states of the IP addresses leased by the adapter specified by AdapterIndex, if any.

The possible values are as follows:

  • (Empty) - Indicates the class was unable to get any information.
  • Invalid
  • Tentative
  • Duplicate
  • Deprecated
  • Preferred
ARPAddress:   Specifies the IP Address of the interface to be used for the GetMAC method.

By default, when GetMAC is called, the class will attempt the address resolution from the first adapter listed by the system. In multihomed machines, it may be necessary to specify the IP address of the interface to be used as the source of the address resolution request. Set this setting to the local IP address of the adapter to be used when making this request.

UseOldApi:   If set the class will use the old API to get Adapter information.

The class uses new system calls to obtain IPv6 as well as IPv4 adapter information. Some of the new system calls, however, are not supported on the XP Windows operating system. Set this configuration setting to True, to use the old system calls when retrieving adapter information.

Note: This functionality is only available in Windows.

Note: This setting should be needed only when using the XP operating system.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (IPInfo Class)

IPInfo Errors

131   Request queue is full.
132   Message for unknown request.
134   Invalid address string.
310   Adapter information is unavailable.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).