Docs

IPWorks 2022 .NET Edition

Version 22.0 [Build 8171]

IPInfo Component

Properties   Methods   Events   Configuration Settings   Errors  

The IPInfo component is used to resolve host names to host addresses and vice-versa using asynchronous DNS. The component provides access to other TCP/IP database functions as well.

Syntax

nsoftware.IPWorks.Ipinfo

Remarks

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

AdapterBroadcastAddressThe broadcast address of the adapter.
AdapterCountThe number of adapters in the system.
AdapterDescriptionThe description of the adapter identified by AdapterIndex .
AdapterDeviceIndexThe system index of the adapter identified by AdapterIndex .
AdapterDHCPEnabledShows whether or not the adapter identified by AdapterIndex has DHCP Enabled.
AdapterDHCPServerThe DHCP server of the adapter identified by AdapterIndex .
AdapterDNSServersThe DNS server list for the adapter identified by AdapterIndex .
AdapterGatewayThe default gateway of the adapter identified by AdapterIndex .
AdapterIndexSets the current adapter.
AdapterIPAddressThe IP address of the adapter identified by AdapterIndex .
AdapterIPv6AddressThe IPv6 address of the adapter identified by AdapterIndex .
AdapterIPv6LinkLocalAddressThe IPv6 link local address of the adapter identified by AdapterIndex .
AdapterLeaseExpiresThe expiration date and time of the lease obtained by the adapter identified by AdapterIndex .
AdapterLeaseObtainedThe date and time of when the current lease was obtained by the adapter identified by AdapterIndex .
AdapterNameThe name of the adapter identified by AdapterIndex .
AdapterOtherIPAddressesOther IP addresses leased by the adapter specified by AdapterIndex , if any.
AdapterPhysicalAddressThe physical address of the adapter identified by AdapterIndex .
AdapterPrimaryWINSServerThe primary WINS server of the adapter identified by AdapterIndex .
AdapterSecondaryWINSServerThe secondary WINS server of the adapter identified by AdapterIndex .
AdapterStatusReturns the current status of the adapter.
AdapterSubnetMaskThe subnet of the adapter identified by AdapterIndex .
AdapterTypeThe type of adapter identified by AdapterIndex .
AdapterUsesWINSShows whether or not the adapter identified by AdapterIndex uses WINS.
AdapterZoneIdThe zone Id of the adapter identified by AdapterIndex .
ARPProxyShows whether the local computer is acting as an ARP proxy.
DHCPScopeThe DHCP Scope of the DHCP server.
DNSEnabledShows whether DNS is enabled on the local computer.
DNSServerThe address of the DNS Server.
DomainNameThe current network domain on which the system resides.
HostAddressAn Internet Address in dotted format. When set, it initiates a search for the corresponding host name.
HostAliasesOther names corresponding to the host with the name HostName.
HostNameThe Domain Name of an Internet host. When set, it initiates a search for the corresponding address(es).
LocalHostThe name of the local host.
NodeTypeThe type of node for the system.
OtherAddressesOther addresses for the host identified by HostName (for multihomed hosts).
OtherDNSServersOther DNS servers configured for the host machine.
PendingRequestsThe number of requests awaiting completion.
RequestIdThe handle of the last request.
RoutingEnabledShows whether routing is enabled on the local computer.
ServiceAliasesOther names by which the service specified by ServiceName / ServicePort is known.
ServiceNameA name for a service. When set, it initiates a search for the corresponding port number and protocol.
ServicePortA port number for a service. When set, it initiates a search for the corresponding service name and protocol.
ServiceProtocolThe protocol of the service specified by ServiceName / ServicePort .

Method List


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

ConfigSets or retrieves a configuration setting.
DHCPReleaseReleases the IP Address of the current adapter specified by AdapterIndex .
DHCPRenewRenews the IP Address of the current adapter specified by AdapterIndex .
DisplayDNSCacheDisplays cached DNS entries.
DoEventsProcesses events from the internal message queue.
FlushDNSCacheFlush the DNS cache.
GetMACReturns the MAC address of the network interface at IPAddress .
ResetResets the component, stopping all pending requests and refreshing network information.
ResolveAddressResolves an IP address.
ResolveNameResolves a host name.

Event List


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

DNSCacheEntryFires once for each cached DNS entry.
ErrorInformation about errors during data delivery.
RequestCompleteFired after an asynchronous request completes.

Configuration Settings


The following is a list of configuration settings for the component 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 component will use the old API to get Adapter information.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

AdapterBroadcastAddress Property (IPInfo Component)

The broadcast address of the adapter.

Syntax

public string AdapterBroadcastAddress { get; }
Public ReadOnly Property AdapterBroadcastAddress As String

Default Value

""

Remarks

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

This property is read-only.

AdapterCount Property (IPInfo Component)

The number of adapters in the system.

Syntax

public int AdapterCount { get; }
Public ReadOnly Property AdapterCount As Integer

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.

This property is not available in Mono.

AdapterDescription Property (IPInfo Component)

The description of the adapter identified by AdapterIndex .

Syntax

public string AdapterDescription { get; }
Public ReadOnly Property AdapterDescription As String

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.

AdapterDeviceIndex Property (IPInfo Component)

The system index of the adapter identified by AdapterIndex .

Syntax

public int AdapterDeviceIndex { get; }
Public ReadOnly Property AdapterDeviceIndex As Integer

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.

AdapterDHCPEnabled Property (IPInfo Component)

Shows whether or not the adapter identified by AdapterIndex has DHCP Enabled.

Syntax

public bool AdapterDHCPEnabled { get; }
Public ReadOnly Property AdapterDHCPEnabled As Boolean

Default Value

False

Remarks

This property indicates whether or not the adapter identified by AdapterIndex has DHCP Enabled. Dynamic Host Configuration Protocol (DHCP) is used for automatically assigning IP Addresses on a network.

NOTE: This functionality is only available in Windows.

This property is read-only.

AdapterDHCPServer Property (IPInfo Component)

The DHCP server of the adapter identified by AdapterIndex .

Syntax

public string AdapterDHCPServer { get; }
Public ReadOnly Property AdapterDHCPServer As String

Default Value

""

Remarks

This property contains the DHCP server of the adapter identified by AdapterIndex. Dynamic Host Configuration Protocol (DHCP) is used for automatically assigning IP Addresses on a network.

NOTE: This functionality is only available in Windows.

This property is read-only.

AdapterDNSServers Property (IPInfo Component)

The DNS server list for the adapter identified by AdapterIndex .

Syntax

public string AdapterDNSServers { get; }
Public ReadOnly Property AdapterDNSServers As String

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.

AdapterGateway Property (IPInfo Component)

The default gateway of the adapter identified by AdapterIndex .

Syntax

public string AdapterGateway { get; }
Public ReadOnly Property AdapterGateway As String

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.

AdapterIndex Property (IPInfo Component)

Sets the current adapter.

Syntax

public int AdapterIndex { get; set; }
Public Property AdapterIndex As Integer

Default Value

0

Remarks

When this property is set, the component 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.

AdapterIPAddress Property (IPInfo Component)

The IP address of the adapter identified by AdapterIndex .

Syntax

public string AdapterIPAddress { get; }
Public ReadOnly Property AdapterIPAddress As String

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.

AdapterIPv6Address Property (IPInfo Component)

The IPv6 address of the adapter identified by AdapterIndex .

Syntax

public string AdapterIPv6Address { get; }
Public ReadOnly Property AdapterIPv6Address As String

Default Value

""

Remarks

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 only available on XP or newer OS versions.

This property is read-only.

AdapterIPv6LinkLocalAddress Property (IPInfo Component)

The IPv6 link local address of the adapter identified by AdapterIndex .

Syntax

public string AdapterIPv6LinkLocalAddress { get; }
Public ReadOnly Property AdapterIPv6LinkLocalAddress As String

Default Value

""

Remarks

The IPv6 link 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.

AdapterLeaseExpires Property (IPInfo Component)

The expiration date and time of the lease obtained by the adapter identified by AdapterIndex .

Syntax

public string AdapterLeaseExpires { get; }
Public ReadOnly Property AdapterLeaseExpires As String

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.

AdapterLeaseObtained Property (IPInfo Component)

The date and time of when the current lease was obtained by the adapter identified by AdapterIndex .

Syntax

public string AdapterLeaseObtained { get; }
Public ReadOnly Property AdapterLeaseObtained As String

Default Value

""

Remarks

This property contains the date and time of 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.

AdapterName Property (IPInfo Component)

The name of the adapter identified by AdapterIndex .

Syntax

public string AdapterName { get; }
Public ReadOnly Property AdapterName As String

Default Value

""

Remarks

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

This property is read-only.

AdapterOtherIPAddresses Property (IPInfo Component)

Other IP addresses leased by the adapter specified by AdapterIndex , if any.

Syntax

public string AdapterOtherIPAddresses { get; }
Public ReadOnly Property AdapterOtherIPAddresses As String

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.

AdapterPhysicalAddress Property (IPInfo Component)

The physical address of the adapter identified by AdapterIndex .

Syntax

public string AdapterPhysicalAddress { get; }
Public ReadOnly Property AdapterPhysicalAddress As String

Default Value

""

Remarks

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

This property is not supported in MacOS or iOS.

This property is read-only.

AdapterPrimaryWINSServer Property (IPInfo Component)

The primary WINS server of the adapter identified by AdapterIndex .

Syntax

public string AdapterPrimaryWINSServer { get; }
Public ReadOnly Property AdapterPrimaryWINSServer As String

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.

AdapterSecondaryWINSServer Property (IPInfo Component)

The secondary WINS server of the adapter identified by AdapterIndex .

Syntax

public string AdapterSecondaryWINSServer { get; }
Public ReadOnly Property AdapterSecondaryWINSServer As String

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.

AdapterStatus Property (IPInfo Component)

Returns the current status of the adapter.

Syntax

public string AdapterStatus { get; }
Public ReadOnly Property AdapterStatus As String

Default Value

""

Remarks

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

Possible values are as follows:

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

This property is not applicable when UseOldApi is true.

This property is read-only.

AdapterSubnetMask Property (IPInfo Component)

The subnet of the adapter identified by AdapterIndex .

Syntax

public string AdapterSubnetMask { get; }
Public ReadOnly Property AdapterSubnetMask As String

Default Value

""

Remarks

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

This property is read-only.

AdapterType Property (IPInfo Component)

The type of adapter identified by AdapterIndex .

Syntax

public string AdapterType { get; }
Public ReadOnly Property AdapterType As String

Default Value

""

Remarks

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

Possible values include:

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

Possible values include (Unix OS):

UPInterface is up
BROADCASTBroadcast address 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.

AdapterUsesWINS Property (IPInfo Component)

Shows whether or not the adapter identified by AdapterIndex uses WINS.

Syntax

public bool AdapterUsesWINS { get; }
Public ReadOnly Property AdapterUsesWINS As Boolean

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 which is used to resolve Windows network hostnames to IP addresses.

NOTE: This functionality is only available in Windows.

This property is read-only.

AdapterZoneId Property (IPInfo Component)

The zone Id of the adapter identified by AdapterIndex .

Syntax

public int AdapterZoneId { get; }
Public ReadOnly Property AdapterZoneId As Integer

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.

ARPProxy Property (IPInfo Component)

Shows whether the local computer is acting as an ARP proxy.

Syntax

public bool ARPProxy { get; }
Public ReadOnly Property ARPProxy As Boolean

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.

DHCPScope Property (IPInfo Component)

The DHCP Scope of the DHCP server.

Syntax

public string DHCPScope { get; }
Public ReadOnly Property DHCPScope As String

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

DNSEnabled Property (IPInfo Component)

Shows whether DNS is enabled on the local computer.

Syntax

public bool DNSEnabled { get; }
Public ReadOnly Property DNSEnabled As Boolean

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.

DNSServer Property (IPInfo Component)

The address of the DNS Server.

Syntax

public string DNSServer { get; }
Public ReadOnly Property DNSServer As String

Default Value

""

Remarks

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

If the component 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.

DomainName Property (IPInfo Component)

The current network domain on which the system resides.

Syntax

public string DomainName { get; }
Public ReadOnly Property DomainName As String

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.

HostAddress Property (IPInfo Component)

An Internet Address in dotted format. When set, it initiates a search for the corresponding host name.

Syntax

public string HostAddress { get; set; }
Public Property HostAddress As 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

HostAliases Property (IPInfo Component)

Other names corresponding to the host with the name HostName.

Syntax

public string HostAliases { get; }
Public ReadOnly Property HostAliases As String

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.

HostName Property (IPInfo Component)

The Domain Name of an Internet host. When set, it initiates a search for the corresponding address(es).

Syntax

public string HostName { get; set; }
Public Property HostName As 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

LocalHost Property (IPInfo Component)

The name of the local host.

Syntax

public string LocalHost { get; }
Public ReadOnly Property LocalHost As String

Default Value

""

Remarks

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

This property is read-only.

NodeType Property (IPInfo Component)

The type of node for the system.

Syntax

public string NodeType { get; }
Public ReadOnly Property NodeType As String

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

OtherAddresses Property (IPInfo Component)

Other addresses for the host identified by HostName (for multihomed hosts).

Syntax

public string OtherAddresses { get; }
Public ReadOnly Property OtherAddresses As String

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.

OtherDNSServers Property (IPInfo Component)

Other DNS servers configured for the host machine.

Syntax

public string OtherDNSServers { get; }
Public ReadOnly Property OtherDNSServers As String

Default Value

""

Remarks

This property contains a space-separated list of DNS servers configured for the host machine. Note that 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.

PendingRequests Property (IPInfo Component)

The number of requests awaiting completion.

Syntax

public int PendingRequests { get; set; }
Public Property PendingRequests As Integer

Default Value

0

Remarks

This property serves two functions: it shows the number of requests that are pending completion, but it can also be used to adjust the size of the queue by dumping part of or all 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.

RequestId Property (IPInfo Component)

The handle of the last request.

Syntax

public int RequestId { get; }
Public ReadOnly Property RequestId As Integer

Default Value

0

Remarks

This property contains the handle of the last request.

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

NOTE: This functionality is only available in Windows.

This property is read-only.

RoutingEnabled Property (IPInfo Component)

Shows whether routing is enabled on the local computer.

Syntax

public bool RoutingEnabled { get; }
Public ReadOnly Property RoutingEnabled As Boolean

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.

ServiceAliases Property (IPInfo Component)

Other names by which the service specified by ServiceName / ServicePort is known.

Syntax

public string ServiceAliases { get; }
Public ReadOnly Property ServiceAliases As String

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.

ServiceName Property (IPInfo Component)

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

Syntax

public string ServiceName { get; set; }
Public Property ServiceName As 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.

ServicePort Property (IPInfo Component)

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

Syntax

public int ServicePort { get; set; }
Public Property ServicePort As 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.

ServiceProtocol Property (IPInfo Component)

The protocol of the service specified by ServiceName / ServicePort .

Syntax

public string ServiceProtocol { get; set; }
Public Property ServiceProtocol As String

Default Value

""

Remarks

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

Setting this property to a particular protocol name (for example '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.

Config Method (IPInfo Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

Releases the IP Address of the current adapter specified by AdapterIndex .

Syntax

public void DHCPRelease();

Async Version
public async Task DHCPRelease();
public async Task DHCPRelease(CancellationToken cancellationToken);
Public Sub DHCPRelease()

Async Version
Public Sub DHCPRelease() As Task
Public Sub DHCPRelease(cancellationToken As CancellationToken) As Task

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.

This method is not available in Mono.

DHCPRenew Method (IPInfo Component)

Renews the IP Address of the current adapter specified by AdapterIndex .

Syntax

public void DHCPRenew();

Async Version
public async Task DHCPRenew();
public async Task DHCPRenew(CancellationToken cancellationToken);
Public Sub DHCPRenew()

Async Version
Public Sub DHCPRenew() As Task
Public Sub DHCPRenew(cancellationToken As CancellationToken) As Task

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 Component)

Displays cached DNS entries.

Syntax

public string DisplayDNSCache();

Async Version
public async Task<string> DisplayDNSCache();
public async Task<string> DisplayDNSCache(CancellationToken cancellationToken);
Public Function DisplayDNSCache() As String

Async Version
Public Function DisplayDNSCache() As Task(Of String)
Public Function DisplayDNSCache(cancellationToken As CancellationToken) As Task(Of String)

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 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 Component)

Processes events from the internal message queue.

Syntax

public void DoEvents();
Public Sub DoEvents()

Remarks

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

FlushDNSCache Method (IPInfo Component)

Flush the DNS cache.

Syntax

public bool FlushDNSCache();

Async Version
public async Task<bool> FlushDNSCache();
public async Task<bool> FlushDNSCache(CancellationToken cancellationToken);
Public Function FlushDNSCache() As Boolean

Async Version
Public Function FlushDNSCache() As Task(Of Boolean)
Public Function FlushDNSCache(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

This method flushes the DNS cache for the system.

NOTE: This functionality is only available in Windows.

GetMAC Method (IPInfo Component)

Returns the MAC address of the network interface at IPAddress .

Syntax

public string GetMAC(string IPAddress);

Async Version
public async Task<string> GetMAC(string IPAddress);
public async Task<string> GetMAC(string IPAddress, CancellationToken cancellationToken);
Public Function GetMAC(ByVal IPAddress As String) As String

Async Version
Public Function GetMAC(ByVal IPAddress As String) As Task(Of String)
Public Function GetMAC(ByVal IPAddress As String, cancellationToken As CancellationToken) As Task(Of String)

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 Component)

Resets the component, stopping all pending requests and refreshing network information.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method resets the component, 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 Component)

Resolves an IP address.

Syntax

public string ResolveAddress(string hostAddress);

Async Version
public async Task<string> ResolveAddress(string hostAddress);
public async Task<string> ResolveAddress(string hostAddress, CancellationToken cancellationToken);
Public Function ResolveAddress(ByVal HostAddress As String) As String

Async Version
Public Function ResolveAddress(ByVal HostAddress As String) As Task(Of String)
Public Function ResolveAddress(ByVal HostAddress As String, cancellationToken As CancellationToken) As Task(Of String)

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)

String hostname = IPInfoControl.ResolveAddress("10.0.1.10");

ResolveName Method (IPInfo Component)

Resolves a host name.

Syntax

public string ResolveName(string hostName);

Async Version
public async Task<string> ResolveName(string hostName);
public async Task<string> ResolveName(string hostName, CancellationToken cancellationToken);
Public Function ResolveName(ByVal HostName As String) As String

Async Version
Public Function ResolveName(ByVal HostName As String) As Task(Of String)
Public Function ResolveName(ByVal HostName As String, cancellationToken As CancellationToken) As Task(Of String)

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)

String ipaddress = IPInfoControl.ResolveName("MyHostName");

DNSCacheEntry Event (IPInfo Component)

Fires once for each cached DNS entry.

Syntax

public event OnDNSCacheEntryHandler OnDNSCacheEntry;

public delegate void OnDNSCacheEntryHandler(object sender, IpinfoDNSCacheEntryEventArgs e);

public class IpinfoDNSCacheEntryEventArgs : EventArgs {
  public string RecordName { get; }

  public int RecordType { get; }

  public int TimeToLive { get; }

  public int DataLength { get; }

  public string Section { get; }

  public string RecordValue { get; }

  public string RecordInfo { get; }

}
Public Event OnDNSCacheEntry As OnDNSCacheEntryHandler

Public Delegate Sub OnDNSCacheEntryHandler(sender As Object, e As IpinfoDNSCacheEntryEventArgs)

Public Class IpinfoDNSCacheEntryEventArgs Inherits EventArgs
  Public ReadOnly Property RecordName As String

  Public ReadOnly Property RecordType As Integer

  Public ReadOnly Property TimeToLive As Integer

  Public ReadOnly Property DataLength As Integer

  Public ReadOnly Property Section As String

  Public ReadOnly Property RecordValue As String

  Public ReadOnly Property RecordInfo As String

End Class

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 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 Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, IpinfoErrorEventArgs e);

public class IpinfoErrorEventArgs : EventArgs {
  public int ErrorCode { get; }

  public string Description { get; }

}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As IpinfoErrorEventArgs)

Public Class IpinfoErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer

  Public ReadOnly Property Description As String

End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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 Component)

Fired after an asynchronous request completes.

Syntax

public event OnRequestCompleteHandler OnRequestComplete;

public delegate void OnRequestCompleteHandler(object sender, IpinfoRequestCompleteEventArgs e);

public class IpinfoRequestCompleteEventArgs : EventArgs {
  public int RequestId { get; }

  public int StatusCode { get; }

  public string Description { get; }

}
Public Event OnRequestComplete As OnRequestCompleteHandler

Public Delegate Sub OnRequestCompleteHandler(sender As Object, e As IpinfoRequestCompleteEventArgs)

Public Class IpinfoRequestCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property RequestId As Integer

  Public ReadOnly Property StatusCode As Integer

  Public ReadOnly Property Description As String

End Class

Remarks

The RequestId parameter specifies the request that just completed. The component 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.

Configuration Settings (IPInfo Component)

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

IPInfo Configuration 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 component 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 component 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 component 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 component will attempt the address resolution from the first adapter listed by the system. In multi-homed 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 component will use the old API to get Adapter information.

The component uses new system calls to obtain IPv6 as well as IPv4 adapter information. Some of the new System calls are not supported on the XP Windows operating system however. Set this config to true to use the old System calls when retrieving adapter information.

NOTE: This functionality is only available in Windows.

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

Base Configuration Settings

BuildInfo:   Information about the product's build.

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

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component 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).
UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (IPInfo Component)

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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 .NET Edition - Version 22.0 [Build 8171]