Docs

IPWorks 2022 Python Edition

Version 22.0 [Build 8171]

IPInfo Class

Properties   Methods   Events   Configuration Settings   Errors  

The IPInfo class is used to resolve host names to host addresses and vice-versa using asynchronous DNS. The class provides access to other TCP/IP database functions as well.

Syntax

class ipworks.IPInfo

Remarks

The IPInfo class operates asynchronously. Requests are posted to the class by setting a property like host_name or host_address and then waiting for the on_request_complete event. The request_id property identifies the request.

Up to 100 simultaneous requests can be queued at any moment. pending_requests 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.

adapter_broadcast_addressThe broadcast address of the adapter.
adapter_countThe number of adapters in the system.
adapter_descriptionThe description of the adapter identified by AdapterIndex .
adapter_device_indexThe system index of the adapter identified by AdapterIndex .
adapter_dhcp_enabledShows whether or not the adapter identified by AdapterIndex has DHCP Enabled.
adapter_dhcp_serverThe DHCP server of the adapter identified by AdapterIndex .
adapter_dns_serversThe DNS server list for the adapter identified by AdapterIndex .
adapter_gatewayThe default gateway of the adapter identified by AdapterIndex .
adapter_indexSets the current adapter.
adapter_ip_addressThe IP address of the adapter identified by AdapterIndex .
adapter_i_pv_6_addressThe IPv6 address of the adapter identified by AdapterIndex .
adapter_i_pv_6_link_local_addressThe IPv6 link local address of the adapter identified by AdapterIndex .
adapter_lease_expiresThe expiration date and time of the lease obtained by the adapter identified by AdapterIndex .
adapter_lease_obtainedThe date and time of when the current lease was obtained by the adapter identified by AdapterIndex .
adapter_nameThe name of the adapter identified by AdapterIndex .
adapter_other_ip_addressesOther IP addresses leased by the adapter specified by AdapterIndex , if any.
adapter_physical_addressThe physical address of the adapter identified by AdapterIndex .
adapter_primary_wins_serverThe primary WINS server of the adapter identified by AdapterIndex .
adapter_secondary_wins_serverThe secondary WINS server of the adapter identified by AdapterIndex .
adapter_statusReturns the current status of the adapter.
adapter_subnet_maskThe subnet of the adapter identified by AdapterIndex .
adapter_typeThe type of adapter identified by AdapterIndex .
adapter_uses_winsShows whether or not the adapter identified by AdapterIndex uses WINS.
adapter_zone_idThe zone Id of the adapter identified by AdapterIndex .
arp_proxyShows whether the local computer is acting as an ARP proxy.
dhcp_scopeThe DHCP Scope of the DHCP server.
dns_enabledShows whether DNS is enabled on the local computer.
dns_serverThe address of the DNS Server.
domain_nameThe current network domain on which the system resides.
host_addressAn Internet Address in dotted format. When set, it initiates a search for the corresponding host name.
host_aliasesOther names corresponding to the host with the name HostName.
host_nameThe Domain Name of an Internet host. When set, it initiates a search for the corresponding address(es).
local_hostThe name of the local host.
node_typeThe type of node for the system.
other_addressesOther addresses for the host identified by HostName (for multihomed hosts).
other_dns_serversOther DNS servers configured for the host machine.
pending_requestsThe number of requests awaiting completion.
request_idThe handle of the last request.
routing_enabledShows whether routing is enabled on the local computer.
service_aliasesOther names by which the service specified by ServiceName / ServicePort is known.
service_nameA name for a service. When set, it initiates a search for the corresponding port number and protocol.
service_portA port number for a service. When set, it initiates a search for the corresponding service name and protocol.
service_protocolThe 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.

configSets or retrieves a configuration setting.
dhcp_releaseReleases the IP Address of the current adapter specified by AdapterIndex .
dhcp_renewRenews the IP Address of the current adapter specified by AdapterIndex .
display_dns_cacheDisplays cached DNS entries.
do_eventsProcesses events from the internal message queue.
flush_dns_cacheFlush the DNS cache.
get_macReturns the MAC address of the network interface at IPAddress .
resetResets the class, stopping all pending requests and refreshing network information.
resolve_addressResolves an IP address.
resolve_nameResolves 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.

on_dns_cache_entryFires once for each cached DNS entry.
on_errorInformation about errors during data delivery.
on_request_completeFired 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.

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 class 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.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

adapter_broadcast_address Property

The broadcast address of the adapter.

Syntax

def get_adapter_broadcast_address() -> str: ...


adapter_broadcast_address = property(get_adapter_broadcast_address, None)

Default Value

""

Remarks

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

This property is read-only.

adapter_count Property

The number of adapters in the system.

Syntax

def get_adapter_count() -> int: ...


adapter_count = property(get_adapter_count, None)

Default Value

0

Remarks

This property shows how many adapters are installed in the system. You can set the adapter_index from 0 to the adapter_count, and then examine the Adapter properties such as adapter_description, adapter_name, and adapter_ip_address to retrieve information about each adapter.

This property is read-only.

adapter_description Property

The description of the adapter identified by AdapterIndex .

Syntax

def get_adapter_description() -> str: ...


adapter_description = property(get_adapter_description, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_device_index Property

The system index of the adapter identified by AdapterIndex .

Syntax

def get_adapter_device_index() -> int: ...


adapter_device_index = property(get_adapter_device_index, None)

Default Value

0

Remarks

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

This property is read-only.

adapter_dhcp_enabled Property

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

Syntax

def get_adapter_dhcp_enabled() -> bool: ...


adapter_dhcp_enabled = property(get_adapter_dhcp_enabled, None)

Default Value

FALSE

Remarks

This property indicates whether or not the adapter identified by adapter_index 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.

adapter_dhcp_server Property

The DHCP server of the adapter identified by AdapterIndex .

Syntax

def get_adapter_dhcp_server() -> str: ...


adapter_dhcp_server = property(get_adapter_dhcp_server, None)

Default Value

""

Remarks

This property contains the DHCP server of the adapter identified by adapter_index. 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.

adapter_dns_servers Property

The DNS server list for the adapter identified by AdapterIndex .

Syntax

def get_adapter_dns_servers() -> str: ...


adapter_dns_servers = property(get_adapter_dns_servers, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_gateway Property

The default gateway of the adapter identified by AdapterIndex .

Syntax

def get_adapter_gateway() -> str: ...


adapter_gateway = property(get_adapter_gateway, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_index Property

Sets the current adapter.

Syntax

def get_adapter_index() -> int: ...

def set_adapter_index(value: int) -> None: ...


adapter_index = property(get_adapter_index, set_adapter_index)

Default Value

0

Remarks

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

adapter_count is the number of adapters located in the system.

adapter_ip_address Property

The IP address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_ip_address() -> str: ...


adapter_ip_address = property(get_adapter_ip_address, None)

Default Value

""

Remarks

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

This property is read-only.

adapter_i_pv_6_address Property

The IPv6 address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_i_pv_6_address() -> str: ...


adapter_i_pv_6_address = property(get_adapter_i_pv_6_address, None)

Default Value

""

Remarks

The IPv6 address of the adapter identified by adapter_index, 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.

adapter_i_pv_6_link_local_address Property

The IPv6 link local address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_i_pv_6_link_local_address() -> str: ...


adapter_i_pv_6_link_local_address = property(get_adapter_i_pv_6_link_local_address, None)

Default Value

""

Remarks

The IPv6 link local address of the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_lease_expires Property

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

Syntax

def get_adapter_lease_expires() -> str: ...


adapter_lease_expires = property(get_adapter_lease_expires, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_lease_obtained Property

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

Syntax

def get_adapter_lease_obtained() -> str: ...


adapter_lease_obtained = property(get_adapter_lease_obtained, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_name Property

The name of the adapter identified by AdapterIndex .

Syntax

def get_adapter_name() -> str: ...


adapter_name = property(get_adapter_name, None)

Default Value

""

Remarks

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

This property is read-only.

adapter_other_ip_addresses Property

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

Syntax

def get_adapter_other_ip_addresses() -> str: ...


adapter_other_ip_addresses = property(get_adapter_other_ip_addresses, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_physical_address Property

The physical address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_physical_address() -> str: ...


adapter_physical_address = property(get_adapter_physical_address, None)

Default Value

""

Remarks

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

This property is not supported in MacOS or iOS.

This property is read-only.

adapter_primary_wins_server Property

The primary WINS server of the adapter identified by AdapterIndex .

Syntax

def get_adapter_primary_wins_server() -> str: ...


adapter_primary_wins_server = property(get_adapter_primary_wins_server, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_secondary_wins_server Property

The secondary WINS server of the adapter identified by AdapterIndex .

Syntax

def get_adapter_secondary_wins_server() -> str: ...


adapter_secondary_wins_server = property(get_adapter_secondary_wins_server, None)

Default Value

""

Remarks

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

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_status Property

Returns the current status of the adapter.

Syntax

def get_adapter_status() -> str: ...


adapter_status = property(get_adapter_status, None)

Default Value

""

Remarks

This proprety holds the current status of the adapter specified by adapter_index.

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.

adapter_subnet_mask Property

The subnet of the adapter identified by AdapterIndex .

Syntax

def get_adapter_subnet_mask() -> str: ...


adapter_subnet_mask = property(get_adapter_subnet_mask, None)

Default Value

""

Remarks

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

This property is read-only.

adapter_type Property

The type of adapter identified by AdapterIndex .

Syntax

def get_adapter_type() -> str: ...


adapter_type = property(get_adapter_type, None)

Default Value

""

Remarks

This property contains the type of adapter identified by adapter_index, 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.

adapter_uses_wins Property

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

Syntax

def get_adapter_uses_wins() -> bool: ...


adapter_uses_wins = property(get_adapter_uses_wins, None)

Default Value

FALSE

Remarks

This property indicates whether or not the adapter identified by adapter_index 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.

adapter_zone_id Property

The zone Id of the adapter identified by AdapterIndex .

Syntax

def get_adapter_zone_id() -> int: ...


adapter_zone_id = property(get_adapter_zone_id, None)

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.

arp_proxy Property

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

Syntax

def get_arp_proxy() -> bool: ...


arp_proxy = property(get_arp_proxy, None)

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.

dhcp_scope Property

The DHCP Scope of the DHCP server.

Syntax

def get_dhcp_scope() -> str: ...


dhcp_scope = property(get_dhcp_scope, None)

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.

dns_enabled Property

Shows whether DNS is enabled on the local computer.

Syntax

def get_dns_enabled() -> bool: ...


dns_enabled = property(get_dns_enabled, None)

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.

dns_server Property

The address of the DNS Server.

Syntax

def get_dns_server() -> str: ...


dns_server = property(get_dns_server, None)

Default Value

""

Remarks

The class attempts to find the default DNS server for the machine where it is installed, and 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.

domain_name Property

The current network domain on which the system resides.

Syntax

def get_domain_name() -> str: ...


domain_name = property(get_domain_name, None)

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.

host_address Property

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

Syntax

def get_host_address() -> str: ...

def set_host_address(value: str) -> None: ...


host_address = property(get_host_address, set_host_address)

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 host_name

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

The on_request_complete event is fired when the search is complete. The request_id 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

host_aliases Property

Other names corresponding to the host with the name HostName.

Syntax

def get_host_aliases() -> str: ...


host_aliases = property(get_host_aliases, None)

Default Value

""

Remarks

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

This property is read-only.

host_name Property

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

Syntax

def get_host_name() -> str: ...

def set_host_name(value: str) -> None: ...


host_name = property(get_host_name, set_host_name)

Default Value

""

Remarks

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

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

The on_request_complete event is fired when the search is complete. The request_id property identifies the pending request.

Example (Resolve a Name)

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

local_host Property

The name of the local host.

Syntax

def get_local_host() -> str: ...


local_host = property(get_local_host, None)

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.

node_type Property

The type of node for the system.

Syntax

def get_node_type() -> str: ...


node_type = property(get_node_type, None)

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.

other_addresses Property

Other addresses for the host identified by HostName (for multihomed hosts).

Syntax

def get_other_addresses() -> str: ...


other_addresses = property(get_other_addresses, None)

Default Value

""

Remarks

This property contains a list of alternate addresses for the host specified by host_name and host_address 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.

other_dns_servers Property

Other DNS servers configured for the host machine.

Syntax

def get_other_dns_servers() -> str: ...


other_dns_servers = property(get_other_dns_servers, None)

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

NOTE: This functionality is only available in Windows.

This property is read-only.

pending_requests Property

The number of requests awaiting completion.

Syntax

def get_pending_requests() -> int: ...

def set_pending_requests(value: int) -> None: ...


pending_requests = property(get_pending_requests, set_pending_requests)

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 pending_requests to 0.

NOTE: This functionality is only available in Windows.

request_id Property

The handle of the last request.

Syntax

def get_request_id() -> int: ...


request_id = property(get_request_id, None)

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 on_request_complete event is fired.

NOTE: This functionality is only available in Windows.

This property is read-only.

routing_enabled Property

Shows whether routing is enabled on the local computer.

Syntax

def get_routing_enabled() -> bool: ...


routing_enabled = property(get_routing_enabled, None)

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.

service_aliases Property

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

Syntax

def get_service_aliases() -> str: ...


service_aliases = property(get_service_aliases, None)

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.

service_name Property

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

Syntax

def get_service_name() -> str: ...

def set_service_name(value: str) -> None: ...


service_name = property(get_service_name, set_service_name)

Default Value

""

Remarks

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

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

The on_request_complete event is fired when the search is complete. request_id identifies the pending request.

NOTE: This functionality is only available in Windows.

service_port Property

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

Syntax

def get_service_port() -> int: ...

def set_service_port(value: int) -> None: ...


service_port = property(get_service_port, set_service_port)

Default Value

0

Remarks

This property contains the port number for the service specified by service_name.

If this property is set to a port number, a search is initiated for the service_name and other information related to the service (if any).

The on_request_complete event is fired when the search is complete. request_id identifies the pending request.

NOTE: This functionality is only available in Windows.

service_protocol Property

The protocol of the service specified by ServiceName / ServicePort .

Syntax

def get_service_protocol() -> str: ...

def set_service_protocol(value: str) -> None: ...


service_protocol = property(get_service_protocol, set_service_protocol)

Default Value

""

Remarks

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

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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

dhcp_release Method

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

Syntax

def dhcp_release() -> None: ...

Remarks

This method releases the IP Address of the current adapter specified by adapter_index. If adapter_dhcp_enabled is true, the lease of the IP Address assigned to the current adapter specified by adapter_index is released.

NOTE: This functionality is only available in Windows.

dhcp_renew Method

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

Syntax

def dhcp_renew() -> None: ...

Remarks

This method renews the IP Address of the current adapter specified by AdapterIndex. If adapter_dhcp_enabled is true, the lease of the IP Address assigned to the current adapter specified by adapter_index is renewed.

NOTE: This functionality is only available in Windows.

display_dns_cache Method

Displays cached DNS entries.

Syntax

def display_dns_cache() -> str: ...

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

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

flush_dns_cache Method

Flush the DNS cache.

Syntax

def flush_dns_cache() -> bool: ...

Remarks

This method flushes the DNS cache for the system.

NOTE: This functionality is only available in Windows.

get_mac Method

Returns the MAC address of the network interface at IPAddress .

Syntax

def get_mac(ip_address: str) -> str: ...

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

Resets the class, stopping all pending requests and refreshing network information.

Syntax

def reset() -> None: ...

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.

resolve_address Method

Resolves an IP address.

Syntax

def resolve_address(host_address: str) -> str: ...

Remarks

This method resolves the IP Address HostAddress and sets host_name to the name of the host corresponding to HostAddress.

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

Example (Resolve an Address)

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

resolve_name Method

Resolves a host name.

Syntax

def resolve_name(host_name: str) -> str: ...

Remarks

This method resolves the host name HostName and sets host_address to the IP Address of the host corresponding to HostName.

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

Example (Resolve a Name)

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

on_dns_cache_entry Event

Fires once for each cached DNS entry.

Syntax

class IPInfoDNSCacheEntryEventParams(object):
  @property
  def record_name() -> str: ...

  @property
  def record_type() -> int: ...

  @property
  def time_to_live() -> int: ...

  @property
  def data_length() -> int: ...

  @property
  def section() -> str: ...

  @property
  def record_value() -> str: ...

  @property
  def record_info() -> str: ...

# In class IPInfo:
@property
def on_dns_cache_entry() -> Callable[[IPInfoDNSCacheEntryEventParams], None]: ...
@on_dns_cache_entry.setter
def on_dns_cache_entry(event_hook: Callable[[IPInfoDNSCacheEntryEventParams], None]) -> None: ...

Remarks

This event fires once for each entry in the local DNS cache when display_dns_cache 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.

on_error Event

Information about errors during data delivery.

Syntax

class IPInfoErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class IPInfo:
@property
def on_error() -> Callable[[IPInfoErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[IPInfoErrorEventParams], None]) -> None: ...

Remarks

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

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.

on_request_complete Event

Fired after an asynchronous request completes.

Syntax

class IPInfoRequestCompleteEventParams(object):
  @property
  def request_id() -> int: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class IPInfo:
@property
def on_request_complete() -> Callable[[IPInfoRequestCompleteEventParams], None]: ...
@on_request_complete.setter
def on_request_complete(event_hook: Callable[[IPInfoRequestCompleteEventParams], None]) -> None: ...

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, host_name, host_address, host_aliases, and other_addresses 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.

IPInfo Configuration

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 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 class 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 class 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 class 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 get_mac is called the class 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 class will use the old API to get Adapter information.

The class 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 class 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).
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

IPInfo Errors

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