IPInfo Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPInfo

Remarks

The IPInfo control operates asynchronously. Requests are posted to the control 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 control with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

AdapterBroadcastAddress Property (IPInfo Control)

This property includes the broadcast address of the adapter.

Syntax

ipinfocontrol.AdapterBroadcastAddress

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 (IPInfo Control)

This property includes the number of adapters in the system.

Syntax

ipinfocontrol.AdapterCount

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterDescription

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterDeviceIndex

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterDHCPEnabled

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterDHCPServer

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterDNSServers

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterGateway

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 (IPInfo Control)

This property sets the current adapter.

Syntax

ipinfocontrol.AdapterIndex[=integer]

Default Value

0

Remarks

When this property is set, the control 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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterIPAddress

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterIPv6Address

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterIPv6LinkLocalAddress

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterLeaseExpires

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterLeaseObtained

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterName

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterOtherIPAddresses

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterPhysicalAddress

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterPrimaryWINSServer

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterSecondaryWINSServer

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 (IPInfo Control)

This property returns the current status of the adapter.

Syntax

ipinfocontrol.AdapterStatus

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterSubnetMask

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 (IPInfo Control)

This property includes the type of adapter identified by AdapterIndex .

Syntax

ipinfocontrol.AdapterType

Default Value

""

Remarks

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

Possible values include the following:

Possible values include the following (Unix OS):

This property is read-only.

Data Type

String

AdapterUsesWINS Property (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterUsesWINS

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 (IPInfo Control)

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

Syntax

ipinfocontrol.AdapterZoneId

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 (IPInfo Control)

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

Syntax

ipinfocontrol.ARPProxy

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 (IPInfo Control)

This property includes the DHCP scope of the DHCP server.

Syntax

ipinfocontrol.DHCPScope

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 (IPInfo Control)

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

Syntax

ipinfocontrol.DNSEnabled

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 (IPInfo Control)

This property includes the address of the DNS server.

Syntax

ipinfocontrol.DNSServer

Default Value

""

Remarks

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

If the control 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 (IPInfo Control)

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

Syntax

ipinfocontrol.DomainName

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 (IPInfo Control)

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

Syntax

ipinfocontrol.HostAddress[=string]

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 (IPInfo Control)

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

Syntax

ipinfocontrol.HostAliases

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 (IPInfo Control)

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

Syntax

ipinfocontrol.HostName[=string]

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 (IPInfo Control)

This property includes the name of the local host.

Syntax

ipinfocontrol.LocalHost

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 (IPInfo Control)

This property includes the type of node for the system.

Syntax

ipinfocontrol.NodeType

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 (IPInfo Control)

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

Syntax

ipinfocontrol.OtherAddresses

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 (IPInfo Control)

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

Syntax

ipinfocontrol.OtherDNSServers

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 (IPInfo Control)

This property includes the number of requests awaiting completion.

Syntax

ipinfocontrol.PendingRequests[=integer]

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 (IPInfo Control)

This property includes the handle of the last request.

Syntax

ipinfocontrol.RequestId

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 (IPInfo Control)

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

Syntax

ipinfocontrol.RoutingEnabled

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 (IPInfo Control)

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

Syntax

ipinfocontrol.ServiceAliases

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 (IPInfo Control)

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

Syntax

ipinfocontrol.ServiceName[=string]

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 (IPInfo Control)

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

Syntax

ipinfocontrol.ServicePort[=integer]

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 (IPInfo Control)

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

Syntax

ipinfocontrol.ServiceProtocol[=string]

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 (IPInfo Control)

Sets or retrieves a configuration setting.

Syntax

ipinfocontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (IPInfo Control)

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

Syntax

ipinfocontrol.DHCPRelease 

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 (IPInfo Control)

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

Syntax

ipinfocontrol.DHCPRenew 

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 (IPInfo Control)

This method displays cached DNS entries.

Syntax

ipinfocontrol.DisplayDNSCache 

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 (IPInfo Control)

This method processes events from the internal message queue.

Syntax

ipinfocontrol.DoEvents 

Remarks

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

FlushDNSCache Method (IPInfo Control)

This method flushes the DNS cache.

Syntax

ipinfocontrol.FlushDNSCache 

Remarks

This method flushes the DNS cache for the system.

Note: This functionality is only available in Windows.

GetMAC Method (IPInfo Control)

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

Syntax

ipinfocontrol.GetMAC 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 (IPInfo Control)

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

Syntax

ipinfocontrol.Reset 

Remarks

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

ResolveAddress Method (IPInfo Control)

This method resolves an IP address.

Syntax

ipinfocontrol.ResolveAddress 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 (IPInfo Control)

This method resolves a host name.

Syntax

ipinfocontrol.ResolveName 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 (IPInfo Control)

This event fires once for each cached DNS entry.

Syntax

Sub ipinfocontrol_DNSCacheEntry(RecordName As String, RecordType As Integer, TimeToLive As Integer, DataLength As Integer, Section As String, RecordValue As String, RecordInfo As String)

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 (IPInfo Control)

Fired when information is available about errors during data delivery.

Syntax

Sub ipinfocontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 (IPInfo Control)

This event is fired after an asynchronous request completes.

Syntax

Sub ipinfocontrol_RequestComplete(RequestId As Integer, StatusCode As Integer, Description As String)

Remarks

The RequestId parameter specifies the request that just completed. The control 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. The value of StatusCode is obtained by adding 15001 to the corresponding system error code.

Please refer to the Error Codes section for more information.

Note: This functionality is only available in Windows.

Config Settings (IPInfo Control)

The control 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 control, access to these internal properties is provided through the Config method.

IPInfo Config Settings

Base Config Settings

Trappable Errors (IPInfo Control)

IPInfo Errors

SSL Errors

TCP/IP Errors