IPInfo Component

Properties   Methods   Events   Config Settings   Errors  

The IPInfo component is used to resolve host names to host addresses and vice versa using an asynchronous DNS. The component provides access to other Transmission Control Protocol (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 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 component with short descriptions. Click on the links for further details.

Method List

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

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.

Config Settings

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

AdapterBroadcastAddress Property (IPInfo Component)

This property includes the broadcast address of the adapter.

Syntax

• C#
• VB.NET

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)

This property includes the number of adapters in the system.

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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

AdapterDHCPServer Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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

AdapterDNSServers Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

This property sets the current adapter.

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

public string AdapterIPv6Address { get; }

Public ReadOnly Property AdapterIPv6Address As String

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.

AdapterIPv6LinkLocalAddress Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

public string AdapterIPv6LinkLocalAddress { get; }

Public ReadOnly Property AdapterIPv6LinkLocalAddress As String

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.

AdapterLeaseExpires Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

public string AdapterLeaseObtained { get; }

Public ReadOnly Property AdapterLeaseObtained As String

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.

AdapterName Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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.

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

This property is read-only.

AdapterPrimaryWINSServer Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

This property returns the current status of the adapter.

Syntax

• C#
• VB.NET

public string AdapterStatus { get; }

Public ReadOnly Property AdapterStatus As String

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.

AdapterSubnetMask Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

This property includes the type of adapter identified by AdapterIndex .

Syntax

• C#
• VB.NET

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

Possible values include the following (Unix OS):

This property is read-only.

AdapterUsesWINS Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

This property includes the DHCP scope of the DHCP server.

Syntax

• C#
• VB.NET

public string DHCPScope { get; }

Public ReadOnly Property DHCPScope As String

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.

DNSEnabled Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

This property includes the address of the DNS server.

Syntax

• C#
• VB.NET

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

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

This property includes the name of the local host.

Syntax

• C#
• VB.NET

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

This property includes the type of node for the system.

Syntax

• C#
• VB.NET

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, and HYBRID.

NOTE: This functionality is only available in Windows.

This property is read-only.

OtherAddresses Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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

This property includes the number of requests awaiting completion.

Syntax

• C#
• VB.NET

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

RequestId Property (IPInfo Component)

This property includes the handle of the last request.

Syntax

• C#
• VB.NET

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

RoutingEnabled Property (IPInfo Component)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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

Config Method (IPInfo Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

This method displays cached DNS entries.

Syntax

• C#
• VB.NET

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

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

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

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)

This method flushes the DNS cache.

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

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

Syntax

• C#
• VB.NET

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)

This method resolves an IP address.

Syntax

• C#
• VB.NET

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)

This method resolves a host name.

Syntax

• C#
• VB.NET

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)

This event fires once for each cached DNS entry.

Syntax

• C#
• VB.NET

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

Information about errors during data delivery.

Syntax

• C#
• VB.NET

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)

This event is fired after an asynchronous request completes.

Syntax

• C#
• VB.NET

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.

Config Settings (IPInfo Component)

IPInfo Config Settings

Base Config Settings

Trappable Errors (IPInfo Component)

IPInfo Errors

SSL Errors

TCP/IP Errors