IPInfo Class
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
ipworks.ipinfo()
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 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 class with short descriptions. Click on the links for further details.
| AdapterCount | The number of adapters in the system. |
| AdapterDescription | The description of the adapter identified by AdapterIndex . |
| AdapterDeviceIndex | The system index of the adapter identified by AdapterIndex . |
| AdapterDHCPEnabled | Shows whether or not the adapter identified by AdapterIndex has DHCP Enabled. |
| AdapterDHCPServer | The DHCP server of the adapter identified by AdapterIndex . |
| AdapterDNSServers | The DNS server list for the adapter identified by AdapterIndex . |
| AdapterGateway | The default gateway of the adapter identified by AdapterIndex . |
| AdapterIndex | Sets the current adapter. |
| AdapterIPAddress | The IP address of the adapter identified by AdapterIndex . |
| AdapterIPv6Address | The IPv6 address of the adapter identified by AdapterIndex . |
| AdapterLeaseExpires | The expiration date and time of the lease obtained by the adapter identified by AdapterIndex . |
| AdapterLeaseObtained | The date and time of when the current lease was obtained by the adapter identified by AdapterIndex . |
| AdapterName | The name of the adapter identified by AdapterIndex . |
| AdapterOtherIPAddresses | Other IP addresses leased by the adapter specified by AdapterIndex , if any. |
| AdapterPhysicalAddress | The physical address of the adapter identified by AdapterIndex . |
| AdapterPrimaryWINSServer | The primary WINS server of the adapter identified by AdapterIndex . |
| AdapterSecondaryWINSServer | The secondary WINS server of the adapter identified by AdapterIndex . |
| AdapterSubnetMask | The subnet of the adapter identified by AdapterIndex . |
| AdapterType | The type of adapter identified by AdapterIndex . |
| AdapterUsesWINS | Shows whether or not the adapter identified by AdapterIndex uses WINS. |
| AdapterZoneId | The zone Id of the adapter identified by AdapterIndex . |
| ARPProxy | Shows whether the local computer is acting as an ARP proxy. |
| DHCPScope | The DHCP Scope of the DHCP server. |
| DNSEnabled | Shows whether DNS is enabled on the local computer. |
| DNSServer | The address of the DNS Server. |
| DomainName | The current network domain on which the system resides. |
| HostAddress | An Internet Address in dotted format. When set, it initiates a search for the corresponding host name. |
| HostAliases | Other names corresponding to the host with the name HostName. |
| HostName | The Domain Name of an Internet host. When set, it initiates a search for the corresponding address(es). |
| LocalHost | The name of the local host. |
| NodeType | The type of node for the system. |
| OtherAddresses | Other addresses for the host identified by HostName (for multihomed hosts). |
| OtherDNSServers | Other DNS servers configured for the host machine. |
| PendingRequests | The number of requests awaiting completion. |
| RequestId | The handle of the last request. |
| RoutingEnabled | Shows whether routing is enabled on the local computer. |
| ServiceAliases | Other names by which the service specified by ServiceName / ServicePort is known. |
| ServiceName | A name for a service. When set, it initiates a search for the corresponding port number and protocol. |
| ServicePort | A port number for a service. When set, it initiates a search for the corresponding service name and protocol. |
| ServiceProtocol | The protocol of the service specified by ServiceName / ServicePort . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| DHCPRelease | Releases the IP Address of the current adapter specified by AdapterIndex . |
| DHCPRenew | Renews the IP Address of the current adapter specified by AdapterIndex . |
| DoEvents | Processes events from the internal message queue. |
| GetMAC | Returns the MAC address of the network interface at IPAddress . |
| Reset | Resets the component, stopping all pending requests and refreshing network information. |
| ResolveAddress | Resolves an IP address. |
| ResolveName | Resolves a host name. |
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.
| Error | Information about errors during data delivery. |
| RequestComplete | Fired after an asynchronous request completes. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| UseOldApi | If set the component will use the old API to get Adapter information. |
| ARPAddress | Specifies the IP Address of the interface to be used for the GetMAC method. |
| AdapterDADState | Specifies the Duplicate Address Detection state of the IP address of the adapter specified by AdapterIndex. |
| AdapterIPv6DADState | Specifies the Duplicate Address Detection state of the IPv6 address of the adapter specified by AdapterIndex. |
| AdapterOtherDADStates | Specifies the Duplicate Address Detection states of the IP addresses leased by the adapter specified by AdapterIndex, if any. |
| CodePage | The system code page used for Unicode to Multibyte translations. |