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

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

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

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

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

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.

AdapterGateway Property (IPInfo Component)

The default gateway of the adapter identified by AdapterIndex .

Syntax

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

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.

AdapterLeaseExpires Property (IPInfo Component)

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

Syntax

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

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

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

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

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

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

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

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

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

Default Value

""

Remarks

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

Possible values include:

Possible values include (Unix OS):

This property is read-only.

AdapterUsesWINS Property (IPInfo Component)

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

Syntax

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.

ARPProxy Property (IPInfo Component)

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

Syntax

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

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

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

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

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

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

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

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

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

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

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

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.

Config Method (Ipinfo Component)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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();

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

public void 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

public String displayDNSCache();

Remarks

This method displays details of the locally cached DNS records.

This method will return a string with information about the DNS cache. In addition the DNSCacheEntry event will fire once per cached entry.

The returned value is in the 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();

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 boolean flushDNSCache();

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

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();

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

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

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 class DefaultIpinfoEventListener implements IpinfoEventListener {
  ...
  public void DNSCacheEntry(IpinfoDNSCacheEntryEvent e) {}
  ...
}

public class IpinfoDNSCacheEntryEvent {
  public String recordName;

  public int recordType;

  public int timeToLive;

  public int dataLength;

  public String section;

  public String recordValue;

  public String recordInfo;

}

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 class DefaultIpinfoEventListener implements IpinfoEventListener {
  ...
  public void error(IpinfoErrorEvent e) {}
  ...
}

public class IpinfoErrorEvent {
  public int errorCode;

  public String description;

}

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 class DefaultIpinfoEventListener implements IpinfoEventListener {
  ...
  public void requestComplete(IpinfoRequestCompleteEvent e) {}
  ...
}

public class IpinfoRequestCompleteEvent {
  public int requestId;

  public int statusCode;

  public String description;

}

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)

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