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.


AdapterBroadcastAddress	This property includes the broadcast address of the adapter.
AdapterCount	This property includes the number of adapters in the system.
AdapterDescription	This property includes the description of the adapter identified by AdapterIndex .
AdapterDeviceIndex	This property includes the system index of the adapter identified by AdapterIndex .
AdapterDHCPEnabled	This property shows whether or not the adapter identified by AdapterIndex has been DHCP enabled.
AdapterDHCPServer	This property includes the DHCP server of the adapter identified by AdapterIndex .
AdapterDNSServers	This property includes the DNS server list for the adapter identified by AdapterIndex .
AdapterGateway	This property includes the default gateway of the adapter identified by AdapterIndex .
AdapterIndex	This property sets the current adapter.
AdapterIPAddress	This property includes the IP address of the adapter identified by AdapterIndex .
AdapterIPv6Address	This is the the IPv6 address of the adapter identified by AdapterIndex .
AdapterIPv6LinkLocalAddress	This property includes the IPv6 link to the local address of the adapter identified by AdapterIndex .
AdapterLeaseExpires	This property includes the expiration date and time of the lease obtained by the adapter identified by AdapterIndex .
AdapterLeaseObtained	This property includes the date and time when the current lease was obtained by the adapter identified by AdapterIndex .
AdapterName	This property includes the name of the adapter identified by AdapterIndex .
AdapterOtherIPAddresses	This property includes the other IP addresses leased by the adapter specified by AdapterIndex , if any.
AdapterPhysicalAddress	This property includes the physical address of the adapter identified by AdapterIndex .
AdapterPrimaryWINSServer	This property includes the primary WINS server of the adapter identified by AdapterIndex .
AdapterSecondaryWINSServer	This property includes the secondary WINS server of the adapter identified by AdapterIndex .
AdapterStatus	This property returns the current status of the adapter.
AdapterSubnetMask	This property includes the subnet of the adapter identified by AdapterIndex .
AdapterType	This property includes the type of adapter identified by AdapterIndex .
AdapterUsesWINS	This property includes the shows whether or not the adapter identified by AdapterIndex uses WINS.
AdapterZoneId	This property includes the zone Id of the adapter identified by AdapterIndex .
ARPProxy	This property shows whether the local computer is acting as an Address Resolution Protocol (ARP) proxy.
DHCPScope	This property includes the DHCP scope of the DHCP server.
DNSEnabled	This property shows whether DNS is enabled on the local computer.
DNSServer	This property includes the address of the DNS server.
DomainName	This property includes the current network domain on which the system resides.
HostAddress	This property includes an internet address in dotted format. When set, it initiates a search for the corresponding host name.
HostAliases	This property includes other names corresponding to the host with the name HostName.
HostName	This property includes the domain name of an internet host. When set, it initiates a search for the corresponding address(es).
LocalHost	This property includes the name of the local host.
NodeType	This property includes the type of node for the system.
OtherAddresses	This property includes other addresses for the host identified by HostName (for multihomed hosts).
OtherDNSServers	This property includes other DNS servers configured for the host machine.
PendingRequests	This property includes the number of requests awaiting completion.
RequestId	This property includes the handle of the last request.
RoutingEnabled	This property shows whether routing is enabled on the local computer.
ServiceAliases	This property includes other names by which the service specified by ServiceName / ServicePort is known.
ServiceName	This property includes the name for a service. When set, it initiates a search for the corresponding port number and protocol.
ServicePort	This property includes a port number for a service. When set, it initiates a search for the corresponding service name and protocol.
ServiceProtocol	This property includes the protocol of the service specified by ServiceName / ServicePort .

Method List

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


Config	Sets or retrieves a configuration setting.
DHCPRelease	This method releases the IP address of the current adapter specified by AdapterIndex .
DHCPRenew	This method renews the IP address of the current adapter specified by AdapterIndex .
DisplayDNSCache	This method displays cached DNS entries.
DoEvents	Processes events from the internal message queue.
FlushDNSCache	This method flushes the DNS cache.
GetMAC	This method returns the MAC address of the network interface at IPAddress .
Reset	This method resets the control, stopping all pending requests and refreshing network information.
ResolveAddress	This method resolves an IP address.
ResolveName	This method resolves a host name.

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.


DNSCacheEntry	This event fires once for each cached DNS entry.
Error	Information about errors during data delivery.
RequestComplete	This event is fired after an asynchronous request completes.

Config Settings

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


AdapterDADState	Specifies the Duplicate Address Detection state of the IP address of the adapter specified by AdapterIndex.
AdapterIPv6DADState	Specifies the Duplicate Address Detection state of the IPv6 address of the adapter specified by AdapterIndex.
AdapterOtherDADStates	Specifies the Duplicate Address Detection states of the IP addresses leased by the adapter specified by AdapterIndex, if any.
ARPAddress	Specifies the IP Address of the interface to be used for the GetMAC method.
UseOldApi	If set the control will use the old API to get Adapter information.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the control whether or not to use the system security libraries or an internal implementation.

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

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

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

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 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:


OTHER	Other
ETHERNET	Ethernet
TOKENRING	Token Ring
FDDI	Fiber Distributed Data Interface
PPP	Point-to-Point Protocol
LOOPBACK	Loopback
SLIP	Serial Line Internet Protocol

Possible values include the following (Unix OS):


UP	Interface is up
BROADCAST	Broadcast address is valid
DEBUG	Turn on debugging
LOOPBACK	Interface is a loopback device
POINTOPOINT	Interface is a point-to-point link
RUNNING	Resources allocated
NOARP	No address resolution protocol
PROMISC	Receive all packets
NOTRAILERS	Avoid use of trailers
ALLMULTI	Receive all multicast packets
MASTER	Master of a load balancer
SLAVE	Slave of a load balancer
MULTICAST	Supports multicast
PORTSEL	Can set media type
AUTOMEDIA	Auto media select active
DYNAMIC	Dialup device with dynamic addresses

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

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

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

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

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)

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)

Information 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.

ErrorCode contains an error code and Description 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

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 control 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 control 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 control 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 control 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 control will use the old API to get Adapter information.

The control 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

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:


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

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

MaskSensitive: 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 to mask sensitive data. The default is .

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

UseInternalSecurityAPI: Tells the control whether or not to use the system security libraries or an internal implementation.

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

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

This setting is set to by default on all platforms.

Trappable Errors (IPInfo Control)

IPInfo Errors

20132    Request queue is full.
20133    Message for unknown request.
20135    Invalid address string.
20311    Adapter information is unavailable.

SSL Errors

20271    Cannot load specified security library.
20272    Cannot open certificate store.
20273    Cannot find specified certificate.
20274    Cannot acquire security credentials.
20275    Cannot find certificate chain.
20276    Cannot verify certificate chain.
20277    Error during handshake.
20281    Error verifying certificate.
20282    Could not find client certificate.
20283    Could not find server certificate.
20284    Error encrypting data.
20285    Error decrypting data.

TCP/IP Errors

25005    [10004] Interrupted system call.
25010    [10009] Bad file number.
25014    [10013] Access denied.
25015    [10014] Bad address.
25023    [10022] Invalid argument.
25025    [10024] Too many open files.
25036    [10035] Operation would block.
25037    [10036] Operation now in progress.
25038    [10037] Operation already in progress.
25039    [10038] Socket operation on non-socket.
25040    [10039] Destination address required.
25041    [10040] Message too long.
25042    [10041] Protocol wrong type for socket.
25043    [10042] Bad protocol option.
25044    [10043] Protocol not supported.
25045    [10044] Socket type not supported.
25046    [10045] Operation not supported on socket.
25047    [10046] Protocol family not supported.
25048    [10047] Address family not supported by protocol family.
25049    [10048] Address already in use.
25050    [10049] Can't assign requested address.
25051    [10050] Network is down.
25052    [10051] Network is unreachable.
25053    [10052] Net dropped connection or reset.
25054    [10053] Software caused connection abort.
25055    [10054] Connection reset by peer.
25056    [10055] No buffer space available.
25057    [10056] Socket is already connected.
25058    [10057] Socket is not connected.
25059    [10058] Can't send after socket shutdown.
25060    [10059] Too many references, can't splice.
25061    [10060] Connection timed out.
25062    [10061] Connection refused.
25063    [10062] Too many levels of symbolic links.
25064    [10063] File name too long.
25065    [10064] Host is down.
25066    [10065] No route to host.
25067    [10066] Directory not empty
25068    [10067] Too many processes.
25069    [10068] Too many users.
25070    [10069] Disc Quota Exceeded.
25071    [10070] Stale NFS file handle.
25072    [10071] Too many levels of remote in path.
25092    [10091] Network subsystem is unavailable.
25093    [10092] WINSOCK DLL Version out of range.
25094    [10093] Winsock not loaded yet.
26002    [11001] Host not found.
26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
26005    [11004] Valid name, no data record (check DNS setup).


	20132 Request queue is full.
	20133 Message for unknown request.
	20135 Invalid address string.
	20311 Adapter information is unavailable.


	20271 Cannot load specified security library.
	20272 Cannot open certificate store.
	20273 Cannot find specified certificate.
	20274 Cannot acquire security credentials.
	20275 Cannot find certificate chain.
	20276 Cannot verify certificate chain.
	20277 Error during handshake.
	20281 Error verifying certificate.
	20282 Could not find client certificate.
	20283 Could not find server certificate.
	20284 Error encrypting data.
	20285 Error decrypting data.


	25005 [10004] Interrupted system call.
	25010 [10009] Bad file number.
	25014 [10013] Access denied.
	25015 [10014] Bad address.
	25023 [10022] Invalid argument.
	25025 [10024] Too many open files.
	25036 [10035] Operation would block.
	25037 [10036] Operation now in progress.
	25038 [10037] Operation already in progress.
	25039 [10038] Socket operation on non-socket.
	25040 [10039] Destination address required.
	25041 [10040] Message too long.
	25042 [10041] Protocol wrong type for socket.
	25043 [10042] Bad protocol option.
	25044 [10043] Protocol not supported.
	25045 [10044] Socket type not supported.
	25046 [10045] Operation not supported on socket.
	25047 [10046] Protocol family not supported.
	25048 [10047] Address family not supported by protocol family.
	25049 [10048] Address already in use.
	25050 [10049] Can't assign requested address.
	25051 [10050] Network is down.
	25052 [10051] Network is unreachable.
	25053 [10052] Net dropped connection or reset.
	25054 [10053] Software caused connection abort.
	25055 [10054] Connection reset by peer.
	25056 [10055] No buffer space available.
	25057 [10056] Socket is already connected.
	25058 [10057] Socket is not connected.
	25059 [10058] Can't send after socket shutdown.
	25060 [10059] Too many references, can't splice.
	25061 [10060] Connection timed out.
	25062 [10061] Connection refused.
	25063 [10062] Too many levels of symbolic links.
	25064 [10063] File name too long.
	25065 [10064] Host is down.
	25066 [10065] No route to host.
	25067 [10066] Directory not empty
	25068 [10067] Too many processes.
	25069 [10068] Too many users.
	25070 [10069] Disc Quota Exceeded.
	25071 [10070] Stale NFS file handle.
	25072 [10071] Too many levels of remote in path.
	25092 [10091] Network subsystem is unavailable.
	25093 [10092] WINSOCK DLL Version out of range.
	25094 [10093] Winsock not loaded yet.
	26002 [11001] Host not found.
	26003 [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005 [11004] Valid name, no data record (check DNS setup).