Docs

IPWorks 2022 Delphi 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

TipwIPInfo

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.
CodePageThe system code page used for Unicode to Multibyte translations.
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

property AdapterBroadcastAddress: String read get_AdapterBroadcastAddress;

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

property AdapterCount: Integer read get_AdapterCount;

Default Value

0

Remarks

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

This property is read-only.

AdapterDescription Property (IPInfo Component)

The description of the adapter identified by AdapterIndex .

Syntax

property AdapterDescription: String read get_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.

AdapterDeviceIndex Property (IPInfo Component)

The system index of the adapter identified by AdapterIndex .

Syntax

property AdapterDeviceIndex: Integer read get_AdapterDeviceIndex;

Default Value

0

Remarks

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

This property is read-only.

AdapterDHCPEnabled Property (IPInfo Component)

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

Syntax

property AdapterDHCPEnabled: Boolean read get_AdapterDHCPEnabled;

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

property AdapterDHCPServer: String read get_AdapterDHCPServer;

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

property AdapterDNSServers: String read get_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.

AdapterGateway Property (IPInfo Component)

The default gateway of the adapter identified by AdapterIndex .

Syntax

property AdapterGateway: String read get_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.

AdapterIndex Property (IPInfo Component)

Sets the current adapter.

Syntax

property AdapterIndex: Integer read get_AdapterIndex write set_AdapterIndex;

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

property AdapterIPAddress: String read get_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.

AdapterIPv6Address Property (IPInfo Component)

The IPv6 address of the adapter identified by AdapterIndex .

Syntax

property AdapterIPv6Address: String read get_AdapterIPv6Address;

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

property AdapterIPv6LinkLocalAddress: String read get_AdapterIPv6LinkLocalAddress;

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

property AdapterLeaseExpires: String read get_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.

AdapterLeaseObtained Property (IPInfo Component)

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

Syntax

property AdapterLeaseObtained: String read get_AdapterLeaseObtained;

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

property AdapterName: String read get_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.

AdapterOtherIPAddresses Property (IPInfo Component)

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

Syntax

property AdapterOtherIPAddresses: String read get_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.

AdapterPhysicalAddress Property (IPInfo Component)

The physical address of the adapter identified by AdapterIndex .

Syntax

property AdapterPhysicalAddress: String read get_AdapterPhysicalAddress;

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

property AdapterPrimaryWINSServer: String read get_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.

AdapterSecondaryWINSServer Property (IPInfo Component)

The secondary WINS server of the adapter identified by AdapterIndex .

Syntax

property AdapterSecondaryWINSServer: String read get_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.

AdapterStatus Property (IPInfo Component)

Returns the current status of the adapter.

Syntax

property AdapterStatus: String read get_AdapterStatus;

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

property AdapterSubnetMask: String read get_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.

AdapterType Property (IPInfo Component)

The type of adapter identified by AdapterIndex .

Syntax

property AdapterType: String read get_AdapterType;

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

property AdapterUsesWINS: Boolean read get_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 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

property AdapterZoneId: Integer read get_AdapterZoneId;

Default Value

0

Remarks

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

NOTE: This functionality is only available in Windows.

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

This property is read-only.

ARPProxy Property (IPInfo Component)

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

Syntax

property ARPProxy: Boolean read get_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.

DHCPScope Property (IPInfo Component)

The DHCP Scope of the DHCP server.

Syntax

property DHCPScope: String read get_DHCPScope;

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

property DNSEnabled: Boolean read get_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.

DNSServer Property (IPInfo Component)

The address of the DNS Server.

Syntax

property DNSServer: String read get_DNSServer;

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

property DomainName: String read get_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.

HostAddress Property (IPInfo Component)

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

Syntax

property HostAddress: String read get_HostAddress write set_HostAddress;

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

property HostAliases: String read get_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.

HostName Property (IPInfo Component)

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

Syntax

property HostName: String read get_HostName write set_HostName;

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

property LocalHost: String read get_LocalHost;

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

property NodeType: String read get_NodeType;

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

property OtherAddresses: String read get_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.

OtherDNSServers Property (IPInfo Component)

Other DNS servers configured for the host machine.

Syntax

property OtherDNSServers: String read get_OtherDNSServers;

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

property PendingRequests: Integer read get_PendingRequests write set_PendingRequests;

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

property RequestId: Integer read get_RequestId;

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

property RoutingEnabled: Boolean read get_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.

ServiceAliases Property (IPInfo Component)

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

Syntax

property ServiceAliases: String read get_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.

ServiceName Property (IPInfo Component)

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

Syntax

property ServiceName: String read get_ServiceName write set_ServiceName;

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

property ServicePort: Integer read get_ServicePort write set_ServicePort;

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

property ServiceProtocol: String read get_ServiceProtocol write set_ServiceProtocol;

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

function Config(ConfigurationString: String): 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

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

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

Syntax

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

Displays cached DNS entries.

Syntax

function DisplayDNSCache(): 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

procedure 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

function FlushDNSCache(): 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

function GetMAC(IPAddress: String): 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

procedure Reset();

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

function ResolveAddress(HostAddress: String): 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)

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

ResolveName Method (IPInfo Component)

Resolves a host name.

Syntax

function ResolveName(HostName: String): 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)

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

DNSCacheEntry Event (IPInfo Component)

Fires once for each cached DNS entry.

Syntax

type TDNSCacheEntryEvent = procedure (
  Sender: TObject;
  const RecordName: String;
  RecordType: Integer;
  TimeToLive: Integer;
  DataLength: Integer;
  const Section: String;
  const RecordValue: String;
  const RecordInfo: String
) of Object;

property OnDNSCacheEntry: TDNSCacheEntryEvent read FOnDNSCacheEntry write FOnDNSCacheEntry;

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

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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

type TRequestCompleteEvent = procedure (
  Sender: TObject;
  RequestId: Integer;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnRequestComplete: TRequestCompleteEvent read FOnRequestComplete write FOnRequestComplete;

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.

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

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

The following is a list of valid code page identifiers:

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

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

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a 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. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

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 Delphi Edition - Version 22.0 [Build 8171]