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.

Syntax

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

This property includes the broadcast address of the adapter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterBroadcastAddress();

Unicode (Windows)
LPWSTR GetAdapterBroadcastAddress();

char* ipworks_ipinfo_getadapterbroadcastaddress(void* lpObj);

QString GetAdapterBroadcastAddress();

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

This property includes the number of adapters in the system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAdapterCount();

Unicode (Windows)
INT GetAdapterCount();

int ipworks_ipinfo_getadaptercount(void* lpObj);

int GetAdapterCount();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterDescription();

Unicode (Windows)
LPWSTR GetAdapterDescription();

char* ipworks_ipinfo_getadapterdescription(void* lpObj);

QString GetAdapterDescription();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAdapterDeviceIndex();

Unicode (Windows)
INT GetAdapterDeviceIndex();

int ipworks_ipinfo_getadapterdeviceindex(void* lpObj);

int GetAdapterDeviceIndex();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAdapterDHCPEnabled();

Unicode (Windows)
BOOL GetAdapterDHCPEnabled();

int ipworks_ipinfo_getadapterdhcpenabled(void* lpObj);

bool GetAdapterDHCPEnabled();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterDHCPServer();

Unicode (Windows)
LPWSTR GetAdapterDHCPServer();

char* ipworks_ipinfo_getadapterdhcpserver(void* lpObj);

QString GetAdapterDHCPServer();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterDNSServers();

Unicode (Windows)
LPWSTR GetAdapterDNSServers();

char* ipworks_ipinfo_getadapterdnsservers(void* lpObj);

QString GetAdapterDNSServers();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterGateway();

Unicode (Windows)
LPWSTR GetAdapterGateway();

char* ipworks_ipinfo_getadaptergateway(void* lpObj);

QString GetAdapterGateway();

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

This property sets the current adapter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAdapterIndex();
int SetAdapterIndex(int iAdapterIndex);

Unicode (Windows)
INT GetAdapterIndex();
INT SetAdapterIndex(INT iAdapterIndex);

int ipworks_ipinfo_getadapterindex(void* lpObj);
int ipworks_ipinfo_setadapterindex(void* lpObj, int iAdapterIndex);

int GetAdapterIndex();
int SetAdapterIndex(int iAdapterIndex);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterIPAddress();

Unicode (Windows)
LPWSTR GetAdapterIPAddress();

char* ipworks_ipinfo_getadapteripaddress(void* lpObj);

QString GetAdapterIPAddress();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterIPv6Address();

Unicode (Windows)
LPWSTR GetAdapterIPv6Address();

char* ipworks_ipinfo_getadapteripv6address(void* lpObj);

QString GetAdapterIPv6Address();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterIPv6LinkLocalAddress();

Unicode (Windows)
LPWSTR GetAdapterIPv6LinkLocalAddress();

char* ipworks_ipinfo_getadapteripv6linklocaladdress(void* lpObj);

QString GetAdapterIPv6LinkLocalAddress();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterLeaseExpires();

Unicode (Windows)
LPWSTR GetAdapterLeaseExpires();

char* ipworks_ipinfo_getadapterleaseexpires(void* lpObj);

QString GetAdapterLeaseExpires();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterLeaseObtained();

Unicode (Windows)
LPWSTR GetAdapterLeaseObtained();

char* ipworks_ipinfo_getadapterleaseobtained(void* lpObj);

QString GetAdapterLeaseObtained();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterName();

Unicode (Windows)
LPWSTR GetAdapterName();

char* ipworks_ipinfo_getadaptername(void* lpObj);

QString GetAdapterName();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterOtherIPAddresses();

Unicode (Windows)
LPWSTR GetAdapterOtherIPAddresses();

char* ipworks_ipinfo_getadapterotheripaddresses(void* lpObj);

QString GetAdapterOtherIPAddresses();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterPhysicalAddress();

Unicode (Windows)
LPWSTR GetAdapterPhysicalAddress();

char* ipworks_ipinfo_getadapterphysicaladdress(void* lpObj);

QString GetAdapterPhysicalAddress();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterPrimaryWINSServer();

Unicode (Windows)
LPWSTR GetAdapterPrimaryWINSServer();

char* ipworks_ipinfo_getadapterprimarywinsserver(void* lpObj);

QString GetAdapterPrimaryWINSServer();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterSecondaryWINSServer();

Unicode (Windows)
LPWSTR GetAdapterSecondaryWINSServer();

char* ipworks_ipinfo_getadaptersecondarywinsserver(void* lpObj);

QString GetAdapterSecondaryWINSServer();

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

This property returns the current status of the adapter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterStatus();

Unicode (Windows)
LPWSTR GetAdapterStatus();

char* ipworks_ipinfo_getadapterstatus(void* lpObj);

QString GetAdapterStatus();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterSubnetMask();

Unicode (Windows)
LPWSTR GetAdapterSubnetMask();

char* ipworks_ipinfo_getadaptersubnetmask(void* lpObj);

QString GetAdapterSubnetMask();

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

This property includes the type of adapter identified by AdapterIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAdapterType();

Unicode (Windows)
LPWSTR GetAdapterType();

char* ipworks_ipinfo_getadaptertype(void* lpObj);

QString GetAdapterType();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAdapterUsesWINS();

Unicode (Windows)
BOOL GetAdapterUsesWINS();

int ipworks_ipinfo_getadapteruseswins(void* lpObj);

bool GetAdapterUsesWINS();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAdapterZoneId();

Unicode (Windows)
INT GetAdapterZoneId();

int ipworks_ipinfo_getadapterzoneid(void* lpObj);

int GetAdapterZoneId();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetARPProxy();

Unicode (Windows)
BOOL GetARPProxy();

int ipworks_ipinfo_getarpproxy(void* lpObj);

bool GetARPProxy();

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

This property includes the DHCP scope of the DHCP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDHCPScope();

Unicode (Windows)
LPWSTR GetDHCPScope();

char* ipworks_ipinfo_getdhcpscope(void* lpObj);

QString GetDHCPScope();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDNSEnabled();

Unicode (Windows)
BOOL GetDNSEnabled();

int ipworks_ipinfo_getdnsenabled(void* lpObj);

bool GetDNSEnabled();

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

This property includes the address of the DNS server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDNSServer();

Unicode (Windows)
LPWSTR GetDNSServer();

char* ipworks_ipinfo_getdnsserver(void* lpObj);

QString GetDNSServer();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDomainName();

Unicode (Windows)
LPWSTR GetDomainName();

char* ipworks_ipinfo_getdomainname(void* lpObj);

QString GetDomainName();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHostAddress();
int SetHostAddress(const char* lpszHostAddress);

Unicode (Windows)
LPWSTR GetHostAddress();
INT SetHostAddress(LPCWSTR lpszHostAddress);

char* ipworks_ipinfo_gethostaddress(void* lpObj);
int ipworks_ipinfo_sethostaddress(void* lpObj, const char* lpszHostAddress);

QString GetHostAddress();
int SetHostAddress(QString qsHostAddress);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHostAliases();

Unicode (Windows)
LPWSTR GetHostAliases();

char* ipworks_ipinfo_gethostaliases(void* lpObj);

QString GetHostAliases();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHostName();
int SetHostName(const char* lpszHostName);

Unicode (Windows)
LPWSTR GetHostName();
INT SetHostName(LPCWSTR lpszHostName);

char* ipworks_ipinfo_gethostname(void* lpObj);
int ipworks_ipinfo_sethostname(void* lpObj, const char* lpszHostName);

QString GetHostName();
int SetHostName(QString qsHostName);

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

This property includes the name of the local host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();

Unicode (Windows)
LPWSTR GetLocalHost();

char* ipworks_ipinfo_getlocalhost(void* lpObj);

QString GetLocalHost();

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

This property includes the type of node for the system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNodeType();

Unicode (Windows)
LPWSTR GetNodeType();

char* ipworks_ipinfo_getnodetype(void* lpObj);

QString GetNodeType();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherAddresses();

Unicode (Windows)
LPWSTR GetOtherAddresses();

char* ipworks_ipinfo_getotheraddresses(void* lpObj);

QString GetOtherAddresses();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherDNSServers();

Unicode (Windows)
LPWSTR GetOtherDNSServers();

char* ipworks_ipinfo_getotherdnsservers(void* lpObj);

QString GetOtherDNSServers();

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

This property includes the number of requests awaiting completion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPendingRequests();
int SetPendingRequests(int iPendingRequests);

Unicode (Windows)
INT GetPendingRequests();
INT SetPendingRequests(INT iPendingRequests);

int ipworks_ipinfo_getpendingrequests(void* lpObj);
int ipworks_ipinfo_setpendingrequests(void* lpObj, int iPendingRequests);

int GetPendingRequests();
int SetPendingRequests(int iPendingRequests);

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

This property includes the handle of the last request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestId();

Unicode (Windows)
INT GetRequestId();

int ipworks_ipinfo_getrequestid(void* lpObj);

int GetRequestId();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRoutingEnabled();

Unicode (Windows)
BOOL GetRoutingEnabled();

int ipworks_ipinfo_getroutingenabled(void* lpObj);

bool GetRoutingEnabled();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceAliases();

Unicode (Windows)
LPWSTR GetServiceAliases();

char* ipworks_ipinfo_getservicealiases(void* lpObj);

QString GetServiceAliases();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceName();
int SetServiceName(const char* lpszServiceName);

Unicode (Windows)
LPWSTR GetServiceName();
INT SetServiceName(LPCWSTR lpszServiceName);

char* ipworks_ipinfo_getservicename(void* lpObj);
int ipworks_ipinfo_setservicename(void* lpObj, const char* lpszServiceName);

QString GetServiceName();
int SetServiceName(QString qsServiceName);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServicePort();
int SetServicePort(int iServicePort);

Unicode (Windows)
INT GetServicePort();
INT SetServicePort(INT iServicePort);

int ipworks_ipinfo_getserviceport(void* lpObj);
int ipworks_ipinfo_setserviceport(void* lpObj, int iServicePort);

int GetServicePort();
int SetServicePort(int iServicePort);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceProtocol();
int SetServiceProtocol(const char* lpszServiceProtocol);

Unicode (Windows)
LPWSTR GetServiceProtocol();
INT SetServiceProtocol(LPCWSTR lpszServiceProtocol);

char* ipworks_ipinfo_getserviceprotocol(void* lpObj);
int ipworks_ipinfo_setserviceprotocol(void* lpObj, const char* lpszServiceProtocol);

QString GetServiceProtocol();
int SetServiceProtocol(QString qsServiceProtocol);

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_ipinfo_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DHCPRelease Method (IPInfo Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DHCPRelease();

Unicode (Windows)
INT DHCPRelease();

int ipworks_ipinfo_dhcprelease(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DHCPRenew Method (IPInfo Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DHCPRenew();

Unicode (Windows)
INT DHCPRenew();

int ipworks_ipinfo_dhcprenew(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DisplayDNSCache Method (IPInfo Class)

This method displays cached DNS entries.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DisplayDNSCache();

Unicode (Windows)
LPWSTR DisplayDNSCache();

char* ipworks_ipinfo_displaydnscache(void* lpObj);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (IPInfo Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_ipinfo_doevents(void* lpObj);

int DoEvents();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

FlushDNSCache Method (IPInfo Class)

This method flushes the DNS cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FlushDNSCache();

Unicode (Windows)
INT FlushDNSCache();

int ipworks_ipinfo_flushdnscache(void* lpObj);

bool FlushDNSCache();

Remarks

This method flushes the DNS cache for the system.

NOTE: This functionality is only available in Windows.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetMAC Method (IPInfo Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMAC(const char* lpszIPAddress);

Unicode (Windows)
LPWSTR GetMAC(LPCWSTR lpszIPAddress);

char* ipworks_ipinfo_getmac(void* lpObj, const char* lpszIPAddress);

QString GetMAC(const QString& qsIPAddress);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (IPInfo Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_ipinfo_reset(void* lpObj);

int Reset();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResolveAddress Method (IPInfo Class)

This method resolves an IP address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ResolveAddress(const char* lpszHostAddress);

Unicode (Windows)
LPWSTR ResolveAddress(LPCWSTR lpszHostAddress);

char* ipworks_ipinfo_resolveaddress(void* lpObj, const char* lpszHostAddress);

QString ResolveAddress(const QString& qsHostAddress);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ResolveName Method (IPInfo Class)

This method resolves a host name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ResolveName(const char* lpszHostName);

Unicode (Windows)
LPWSTR ResolveName(LPCWSTR lpszHostName);

char* ipworks_ipinfo_resolvename(void* lpObj, const char* lpszHostName);

QString ResolveName(const QString& qsHostName);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DNSCacheEntry Event (IPInfo Class)

This event fires once for each cached DNS entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDNSCacheEntry(IPInfoDNSCacheEntryEventParams *e);

typedef struct {
  const char *RecordName;
  int RecordType;
  int TimeToLive;
  int DataLength;
  const char *Section;
  const char *RecordValue;
  const char *RecordInfo;
  int reserved;
} IPInfoDNSCacheEntryEventParams;


Unicode (Windows)
virtual INT FireDNSCacheEntry(IPInfoDNSCacheEntryEventParams *e);

typedef struct {
  LPCWSTR RecordName;
  INT RecordType;
  INT TimeToLive;
  INT DataLength;
  LPCWSTR Section;
  LPCWSTR RecordValue;
  LPCWSTR RecordInfo;
  INT reserved;
} IPInfoDNSCacheEntryEventParams;

#define EID_IPINFO_DNSCACHEENTRY 1

virtual INT IPWORKS_CALL FireDNSCacheEntry(LPSTR &lpszRecordName, INT &iRecordType, INT &iTimeToLive, INT &iDataLength, LPSTR &lpszSection, LPSTR &lpszRecordValue, LPSTR &lpszRecordInfo);

class IPInfoDNSCacheEntryEventParams {
public:
  const QString &RecordName();

  int RecordType();

  int TimeToLive();

  int DataLength();

  const QString &Section();

  const QString &RecordValue();

  const QString &RecordInfo();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DNSCacheEntry(IPInfoDNSCacheEntryEventParams *e);

// Or, subclass IPInfo and override this emitter function.
virtual int FireDNSCacheEntry(IPInfoDNSCacheEntryEventParams *e) {...}

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

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(IPInfoErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} IPInfoErrorEventParams;


Unicode (Windows)
virtual INT FireError(IPInfoErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} IPInfoErrorEventParams;

#define EID_IPINFO_ERROR 2

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class IPInfoErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(IPInfoErrorEventParams *e);

// Or, subclass IPInfo and override this emitter function.
virtual int FireError(IPInfoErrorEventParams *e) {...}

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

This event is fired after an asynchronous request completes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRequestComplete(IPInfoRequestCompleteEventParams *e);

typedef struct {
  int RequestId;
  int StatusCode;
  const char *Description;
  int reserved;
} IPInfoRequestCompleteEventParams;


Unicode (Windows)
virtual INT FireRequestComplete(IPInfoRequestCompleteEventParams *e);

typedef struct {
  INT RequestId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} IPInfoRequestCompleteEventParams;

#define EID_IPINFO_REQUESTCOMPLETE 3

virtual INT IPWORKS_CALL FireRequestComplete(INT &iRequestId, INT &iStatusCode, LPSTR &lpszDescription);

class IPInfoRequestCompleteEventParams {
public:
  int RequestId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RequestComplete(IPInfoRequestCompleteEventParams *e);

// Or, subclass IPInfo and override this emitter function.
virtual int FireRequestComplete(IPInfoRequestCompleteEventParams *e) {...}

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)

IPInfo Config Settings

Base Config Settings

Trappable Errors (IPInfo Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

IPInfo Errors

SSL Errors

TCP/IP Errors