IPInfo Class

Properties   Methods   Events   Config Settings   Errors  

The IPInfo class is used to resolve host names to host addresses and vice versa using an asynchronous DNS. The class provides access to other Transmission Control Protocol (TCP)/IP database functions as well.

Class Name

IPWorks_IPInfo

Procedural Interface

 ipworks_ipinfo_open();
 ipworks_ipinfo_close($res);
 ipworks_ipinfo_register_callback($res, $id, $function);
 ipworks_ipinfo_get_last_error($res);
 ipworks_ipinfo_get_last_error_code($res);
 ipworks_ipinfo_set($res, $id, $index, $value);
 ipworks_ipinfo_get($res, $id, $index);
 ipworks_ipinfo_do_config($res, $configurationstring);
 ipworks_ipinfo_do_dhcprelease($res);
 ipworks_ipinfo_do_dhcprenew($res);
 ipworks_ipinfo_do_displaydnscache($res);
 ipworks_ipinfo_do_doevents($res);
 ipworks_ipinfo_do_flushdnscache($res);
 ipworks_ipinfo_do_getmac($res, $ipaddress);
 ipworks_ipinfo_do_reset($res);
 ipworks_ipinfo_do_resolveaddress($res, $hostaddress);
 ipworks_ipinfo_do_resolvename($res, $hostname);

Remarks

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AdapterBroadcastAddress Property (IPWorks_IPInfo Class)

This property includes the broadcast address of the adapter.

Object Oriented Interface

public function getAdapterBroadcastAddress();

Procedural Interface

ipworks_ipinfo_get($res, 1 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

AdapterCount Property (IPWorks_IPInfo Class)

This property includes the number of adapters in the system.

Object Oriented Interface

public function getAdapterCount();

Procedural Interface

ipworks_ipinfo_get($res, 2 );

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.

Data Type

Integer

AdapterDescription Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterDescription();

Procedural Interface

ipworks_ipinfo_get($res, 3 );

Default Value

''

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterDeviceIndex Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterDeviceIndex();

Procedural Interface

ipworks_ipinfo_get($res, 4 );

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.

Data Type

Integer

AdapterDHCPEnabled Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterDHCPEnabled();

Procedural Interface

ipworks_ipinfo_get($res, 5 );

Default Value

false

Remarks

This property indicates whether or not the adapter identified by AdapterIndex has been DHCP enabled. The Dynamic Host Configuration Protocol (DHCP) is used to automatically assign IP addresses on a network.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

AdapterDHCPServer Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterDHCPServer();

Procedural Interface

ipworks_ipinfo_get($res, 6 );

Default Value

''

Remarks

This property contains the DHCP server of the adapter identified by AdapterIndex. The Dynamic Host Configuration Protocol (DHCP) is used to automatically assign IP addresses on a network.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterDNSServers Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterDNSServers();

Procedural Interface

ipworks_ipinfo_get($res, 7 );

Default Value

''

Remarks

This property contains a space-separated list of DNS servers for the adapter specified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterGateway Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterGateway();

Procedural Interface

ipworks_ipinfo_get($res, 8 );

Default Value

''

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterIndex Property (IPWorks_IPInfo Class)

This property sets the current adapter.

Object Oriented Interface

public function getAdapterIndex();
public function setAdapterIndex($value);

Procedural Interface

ipworks_ipinfo_get($res, 9 );
ipworks_ipinfo_set($res, 9, $value );

Default Value

0

Remarks

When this property is set, the class asks the system for information on the adapter with an index of AdapterIndex. If the system has information, the adapter properties will be populated with the data returned.

AdapterCount is the number of adapters located in the system.

Data Type

Integer

AdapterIPAddress Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterIPAddress();

Procedural Interface

ipworks_ipinfo_get($res, 10 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

AdapterIPv6Address Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterIPv6Address();

Procedural Interface

ipworks_ipinfo_get($res, 11 );

Default Value

''

Remarks

This is the IPv6 address of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

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

This property is read-only.

Data Type

String

AdapterIPv6LinkLocalAddress Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterIPv6LinkLocalAddress();

Procedural Interface

ipworks_ipinfo_get($res, 12 );

Default Value

''

Remarks

This property includes the IPv6 link to the local address of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterLeaseExpires Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterLeaseExpires();

Procedural Interface

ipworks_ipinfo_get($res, 13 );

Default Value

''

Remarks

This property contains the expiration date and time of the lease obtained by the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterLeaseObtained Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterLeaseObtained();

Procedural Interface

ipworks_ipinfo_get($res, 14 );

Default Value

''

Remarks

This property contains the date and time when the current lease was obtained by the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterName Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterName();

Procedural Interface

ipworks_ipinfo_get($res, 15 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

AdapterOtherIPAddresses Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterOtherIPAddresses();

Procedural Interface

ipworks_ipinfo_get($res, 16 );

Default Value

''

Remarks

This property contains a space-separated list of any other IP addresses leased by the adapter specified by AdapterIndex, if any.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterPhysicalAddress Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterPhysicalAddress();

Procedural Interface

ipworks_ipinfo_get($res, 17 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

AdapterPrimaryWINSServer Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterPrimaryWINSServer();

Procedural Interface

ipworks_ipinfo_get($res, 18 );

Default Value

''

Remarks

This property contains the primary WINS server of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterSecondaryWINSServer Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterSecondaryWINSServer();

Procedural Interface

ipworks_ipinfo_get($res, 19 );

Default Value

''

Remarks

This property contains the secondary WINS server of the adapter identified by AdapterIndex, as returned by the system.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

AdapterStatus Property (IPWorks_IPInfo Class)

This property returns the current status of the adapter.

Object Oriented Interface

public function getAdapterStatus();

Procedural Interface

ipworks_ipinfo_get($res, 20 );

Default Value

''

Remarks

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

Possible values are as follows:

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

Note: This property is not applicable when UseOldApi is True.

This property is read-only.

Data Type

String

AdapterSubnetMask Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterSubnetMask();

Procedural Interface

ipworks_ipinfo_get($res, 21 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

AdapterType Property (IPWorks_IPInfo Class)

This property includes the type of adapter identified by AdapterIndex .

Object Oriented Interface

public function getAdapterType();

Procedural Interface

ipworks_ipinfo_get($res, 22 );

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.

Data Type

String

AdapterUsesWINS Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterUsesWINS();

Procedural Interface

ipworks_ipinfo_get($res, 23 );

Default Value

false

Remarks

This property indicates whether or not the adapter identified by AdapterIndex uses WINS. Windows Internet Name Service (WINS) is a name resolution service that is used to resolve Windows network hostnames to IP addresses.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

AdapterZoneId Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getAdapterZoneId();

Procedural Interface

ipworks_ipinfo_get($res, 24 );

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.

Data Type

Integer

ARPProxy Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getARPProxy();

Procedural Interface

ipworks_ipinfo_get($res, 25 );

Default Value

false

Remarks

This property indicates whether the local computer is acting as an ARP proxy. If True, the local computer will act as an ARP proxy and will respond to ARP requests with its own hardware address.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

DHCPScope Property (IPWorks_IPInfo Class)

This property includes the DHCP scope of the DHCP server.

Object Oriented Interface

public function getDHCPScope();

Procedural Interface

ipworks_ipinfo_get($res, 26 );

Default Value

''

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

DNSEnabled Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getDNSEnabled();

Procedural Interface

ipworks_ipinfo_get($res, 27 );

Default Value

false

Remarks

This property indicates whether DNS is enabled on the local computer. If True, DNS is enabled, and name resolution will be available.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

Boolean

DNSServer Property (IPWorks_IPInfo Class)

This property includes the address of the DNS server.

Object Oriented Interface

public function getDNSServer();

Procedural Interface

ipworks_ipinfo_get($res, 28 );

Default Value

''

Remarks

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

If the class cannot determine the default DNS server address, this property value will be an empty string.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

DomainName Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getDomainName();

Procedural Interface

ipworks_ipinfo_get($res, 29 );

Default Value

''

Remarks

This property contains the domain name to which the system is joined.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

HostAddress Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getHostAddress();
public function setHostAddress($value);

Procedural Interface

ipworks_ipinfo_get($res, 30 );
ipworks_ipinfo_set($res, 30, $value );

Default Value

''

Remarks

This property contains the IP address (in internet dotted format aaa.bbb.ccc.ddd) of the host whose domain name is specified by HostName

If HostAddress is set to an IP address, a search is initiated for the corresponding host names(s).

The RequestComplete event is fired when the search is complete. The RequestId property identifies the pending request.

Example. Resolve an Address:

IPInfoControl.HostAddress = "10.0.1.10" While IPInfoControl.PendingRequests > 0 IPInfoControl.DoEvents() End While ResolvedName = IPInfoControl.HostName

Data Type

String

HostAliases Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getHostAliases();

Procedural Interface

ipworks_ipinfo_get($res, 31 );

Default Value

''

Remarks

This property contains a list of alternate names for the host specified by HostName and HostAddress separated by spaces.

This property is read-only.

Data Type

String

HostName Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getHostName();
public function setHostName($value);

Procedural Interface

ipworks_ipinfo_get($res, 32 );
ipworks_ipinfo_set($res, 32, $value );

Default Value

''

Remarks

This property contains the domain name of the host whose IP address is specified by HostAddress.

If this property is set to a domain name, a search is initiated for the corresponding host address(s).

The RequestComplete event is fired when the search is complete. The RequestId property identifies the pending request.

Example. Resolve a Name:

IPInfoControl.HostName = "MyHostName" While IPInfoControl.PendingRequests > 0 IPInfoControl.DoEvents() End While ResolvedAddress = IPInfoControl.HostAddress

Data Type

String

LocalHost Property (IPWorks_IPInfo Class)

This property includes the name of the local host.

Object Oriented Interface

public function getLocalHost();

Procedural Interface

ipworks_ipinfo_get($res, 33 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

NodeType Property (IPWorks_IPInfo Class)

This property includes the type of node for the system.

Object Oriented Interface

public function getNodeType();

Procedural Interface

ipworks_ipinfo_get($res, 34 );

Default Value

''

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

OtherAddresses Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getOtherAddresses();

Procedural Interface

ipworks_ipinfo_get($res, 35 );

Default Value

''

Remarks

This property contains a list of alternate addresses for the host specified by HostName and HostAddress separated by spaces. Most hosts have only one IP interface. This property is useful when querying multihomed hosts (hosts with more than one interface).

This property is read-only.

Data Type

String

OtherDNSServers Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getOtherDNSServers();

Procedural Interface

ipworks_ipinfo_get($res, 36 );

Default Value

''

Remarks

This property contains a space-separated list of DNS servers configured for the host machine. Note: The primary server is provided in the DNSServer property.

Note: This functionality is only available in Windows.

This property is read-only and not available at design time.

Data Type

String

PendingRequests Property (IPWorks_IPInfo Class)

This property includes the number of requests awaiting completion.

Object Oriented Interface

public function getPendingRequests();
public function setPendingRequests($value);

Procedural Interface

ipworks_ipinfo_get($res, 37 );
ipworks_ipinfo_set($res, 37, $value );

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.

Data Type

Integer

RequestId Property (IPWorks_IPInfo Class)

This property includes the handle of the last request.

Object Oriented Interface

public function getRequestId();

Procedural Interface

ipworks_ipinfo_get($res, 38 );

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.

Data Type

Integer

RoutingEnabled Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getRoutingEnabled();

Procedural Interface

ipworks_ipinfo_get($res, 39 );

Default Value

false

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only and not available at design time.

Data Type

Boolean

ServiceAliases Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getServiceAliases();

Procedural Interface

ipworks_ipinfo_get($res, 40 );

Default Value

''

Remarks

This property contains a list of alternate service names separated by spaces. In most cases, this list is empty.

Note: This functionality is only available in Windows.

This property is read-only.

Data Type

String

ServiceName Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getServiceName();
public function setServiceName($value);

Procedural Interface

ipworks_ipinfo_get($res, 41 );
ipworks_ipinfo_set($res, 41, $value );

Default Value

''

Remarks

This property contains the name of the specified service located at ServicePort.

If this property is set to a service name, a search is initiated for the corresponding ServicePort and other information related to the service (if any).

The RequestComplete event is fired when the search is complete. RequestId identifies the pending request.

Note: This functionality is only available in Windows.

Data Type

String

ServicePort Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getServicePort();
public function setServicePort($value);

Procedural Interface

ipworks_ipinfo_get($res, 42 );
ipworks_ipinfo_set($res, 42, $value );

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.

Data Type

Integer

ServiceProtocol Property (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function getServiceProtocol();
public function setServiceProtocol($value);

Procedural Interface

ipworks_ipinfo_get($res, 43 );
ipworks_ipinfo_set($res, 43, $value );

Default Value

''

Remarks

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

Setting this property to a particular protocol name (e.g., 'udp' or 'tcp') will force a search for a service for that protocol only. If this property is set to "" (empty string), then the first entry for the service will be returned and this property will be set to the corresponding protocol.

Note: This functionality is only available in Windows.

Data Type

String

Config Method (IPWorks_IPInfo Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_ipinfo_do_config($res, $configurationstring);

Remarks

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

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

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

Object Oriented Interface

public function doDHCPRelease();

Procedural Interface

ipworks_ipinfo_do_dhcprelease($res);

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 (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function doDHCPRenew();

Procedural Interface

ipworks_ipinfo_do_dhcprenew($res);

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 (IPWorks_IPInfo Class)

This method displays cached DNS entries.

Object Oriented Interface

public function doDisplayDNSCache();

Procedural Interface

ipworks_ipinfo_do_displaydnscache($res);

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 (IPWorks_IPInfo Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_ipinfo_do_doevents($res);

Remarks

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

FlushDNSCache Method (IPWorks_IPInfo Class)

This method flushes the DNS cache.

Object Oriented Interface

public function doFlushDNSCache();

Procedural Interface

ipworks_ipinfo_do_flushdnscache($res);

Remarks

This method flushes the DNS cache for the system.

Note: This functionality is only available in Windows.

GetMAC Method (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function doGetMAC($ipaddress);

Procedural Interface

ipworks_ipinfo_do_getmac($res, $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 (IPWorks_IPInfo Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_ipinfo_do_reset($res);

Remarks

This method resets the class, stopping all pending requests and refreshing network information. If the network configuration has changed, call this method to retrieve the latest information.

ResolveAddress Method (IPWorks_IPInfo Class)

This method resolves an IP address.

Object Oriented Interface

public function doResolveAddress($hostaddress);

Procedural Interface

ipworks_ipinfo_do_resolveaddress($res, $hostaddress);

Remarks

This method resolves the IP address HostAddress and sets HostName to the name of the host corresponding to HostAddress.

Calling this method is equivalent to setting the HostAddress property to HostAddress.

Example. Resolve an Address:

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

ResolveName Method (IPWorks_IPInfo Class)

This method resolves a host name.

Object Oriented Interface

public function doResolveName($hostname);

Procedural Interface

ipworks_ipinfo_do_resolvename($res, $hostname);

Remarks

This method resolves the host name HostName and sets HostAddress to the IP address of the host corresponding to HostName.

Calling this method is equivalent to setting the HostName property to HostName.

Example. Resolve a Name:

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

DNSCacheEntry Event (IPWorks_IPInfo Class)

This event fires once for each cached DNS entry.

Object Oriented Interface

public function fireDNSCacheEntry($param);

Procedural Interface

ipworks_ipinfo_register_callback($res, 1, array($this, 'fireDNSCacheEntry'));

Parameter List

 'recordname'
 'recordtype'
 'timetolive'
 'datalength'
 'section'
 'recordvalue'
 '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, 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 (IPWorks_IPInfo Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_ipinfo_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter 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 (IPWorks_IPInfo Class)

This event is fired after an asynchronous request completes.

Object Oriented Interface

public function fireRequestComplete($param);

Procedural Interface

ipworks_ipinfo_register_callback($res, 3, array($this, 'fireRequestComplete'));

Parameter List

 'requestid'
 'statuscode'
 'description'

Remarks

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

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

IPInfo Config Settings

Base Config Settings

Trappable Errors (IPInfo Class)

IPInfo Errors

SSL Errors

TCP/IP Errors