IPInfo Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorks.IPInfo

Remarks

The IPInfo class operates asynchronously. Requests are posted to the class by setting a property like HostName or HostAddress and then waiting for the RequestComplete event. The RequestId property identifies the request.

Up to 100 simultaneous requests can be queued at any moment. PendingRequests shows the number of pending requests and 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AdapterBroadcastAddress Property (IPInfo Module)

This property includes the broadcast address of the adapter.

Syntax

• Swift
• Objective-C

public var adapterBroadcastAddress: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterBroadcastAddress) NSString* adapterBroadcastAddress;

- (NSString*)adapterBroadcastAddress;

Default Value

""

Remarks

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

This property is read-only.

AdapterCount Property (IPInfo Module)

This property includes the number of adapters in the system.

Syntax

• Swift
• Objective-C

public var adapterCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterCount) int adapterCount;

- (int)adapterCount;

Default Value

0

Remarks

This property shows how many adapters are installed in the system. You can set the AdapterIndex from 0 to the AdapterCount and then examine the adapter properties, such as AdapterDescription, AdapterName, and AdapterIPAddress, to retrieve information about each adapter.

This property is read-only.

AdapterDescription Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterDescription: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterDescription) NSString* adapterDescription;

- (NSString*)adapterDescription;

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterDeviceIndex Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterDeviceIndex: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterDeviceIndex) int adapterDeviceIndex;

- (int)adapterDeviceIndex;

Default Value

0

Remarks

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

This property is read-only.

AdapterDHCPEnabled Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterDHCPEnabled: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterDHCPEnabled) BOOL adapterDHCPEnabled;

- (BOOL)adapterDHCPEnabled;

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.

AdapterDHCPServer Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterDHCPServer: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterDHCPServer) NSString* adapterDHCPServer;

- (NSString*)adapterDHCPServer;

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.

AdapterDNSServers Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterDNSServers: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterDNSServers) NSString* adapterDNSServers;

- (NSString*)adapterDNSServers;

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.

AdapterGateway Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterGateway: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterGateway) NSString* adapterGateway;

- (NSString*)adapterGateway;

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterIndex Property (IPInfo Module)

This property sets the current adapter.

Syntax

• Swift
• Objective-C

public var adapterIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=adapterIndex,setter=setAdapterIndex:) int adapterIndex;

- (int)adapterIndex;
- (void)setAdapterIndex :(int)newAdapterIndex;

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.

AdapterIPAddress Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterIPAddress: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterIPAddress) NSString* adapterIPAddress;

- (NSString*)adapterIPAddress;

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.

AdapterIPv6Address Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterIPv6Address: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterIPv6Address) NSString* adapterIPv6Address;

- (NSString*)adapterIPv6Address;

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.

AdapterIPv6LinkLocalAddress Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterIPv6LinkLocalAddress: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterIPv6LinkLocalAddress) NSString* adapterIPv6LinkLocalAddress;

- (NSString*)adapterIPv6LinkLocalAddress;

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.

AdapterLeaseExpires Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterLeaseExpires: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterLeaseExpires) NSString* adapterLeaseExpires;

- (NSString*)adapterLeaseExpires;

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterLeaseObtained Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterLeaseObtained: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterLeaseObtained) NSString* adapterLeaseObtained;

- (NSString*)adapterLeaseObtained;

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.

AdapterName Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterName: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterName) NSString* adapterName;

- (NSString*)adapterName;

Default Value

""

Remarks

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

This property is read-only.

AdapterOtherIPAddresses Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterOtherIPAddresses: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterOtherIPAddresses) NSString* adapterOtherIPAddresses;

- (NSString*)adapterOtherIPAddresses;

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterPhysicalAddress Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterPhysicalAddress: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterPhysicalAddress) NSString* adapterPhysicalAddress;

- (NSString*)adapterPhysicalAddress;

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.

AdapterPrimaryWINSServer Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterPrimaryWINSServer: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterPrimaryWINSServer) NSString* adapterPrimaryWINSServer;

- (NSString*)adapterPrimaryWINSServer;

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterSecondaryWINSServer Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterSecondaryWINSServer: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterSecondaryWINSServer) NSString* adapterSecondaryWINSServer;

- (NSString*)adapterSecondaryWINSServer;

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterStatus Property (IPInfo Module)

This property returns the current status of the adapter.

Syntax

• Swift
• Objective-C

public var adapterStatus: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterStatus) NSString* adapterStatus;

- (NSString*)adapterStatus;

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.

AdapterSubnetMask Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterSubnetMask: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterSubnetMask) NSString* adapterSubnetMask;

- (NSString*)adapterSubnetMask;

Default Value

""

Remarks

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

This property is read-only.

AdapterType Property (IPInfo Module)

This property includes the type of adapter identified by AdapterIndex .

Syntax

• Swift
• Objective-C

public var adapterType: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterType) NSString* adapterType;

- (NSString*)adapterType;

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.

AdapterUsesWINS Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterUsesWINS: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterUsesWINS) BOOL adapterUsesWINS;

- (BOOL)adapterUsesWINS;

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.

AdapterZoneId Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var adapterZoneId: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=adapterZoneId) int adapterZoneId;

- (int)adapterZoneId;

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.

ARPProxy Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var arpProxy: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=ARPProxy) BOOL ARPProxy;

- (BOOL)ARPProxy;

Default Value

False

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

DHCPScope Property (IPInfo Module)

This property includes the DHCP scope of the DHCP server.

Syntax

• Swift
• Objective-C

public var dhcpScope: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=DHCPScope) NSString* DHCPScope;

- (NSString*)DHCPScope;

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.

DNSEnabled Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var dnsEnabled: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=DNSEnabled) BOOL DNSEnabled;

- (BOOL)DNSEnabled;

Default Value

False

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

DNSServer Property (IPInfo Module)

This property includes the address of the DNS server.

Syntax

• Swift
• Objective-C

public var dnsServer: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=DNSServer) NSString* DNSServer;

- (NSString*)DNSServer;

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.

DomainName Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var domainName: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=domainName) NSString* domainName;

- (NSString*)domainName;

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

HostAddress Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var hostAddress: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=hostAddress,setter=setHostAddress:) NSString* hostAddress;

- (NSString*)hostAddress;
- (void)setHostAddress :(NSString*)newHostAddress;

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

HostAliases Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var hostAliases: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=hostAliases) NSString* hostAliases;

- (NSString*)hostAliases;

Default Value

""

Remarks

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

This property is read-only.

HostName Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var hostName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=hostName,setter=setHostName:) NSString* hostName;

- (NSString*)hostName;
- (void)setHostName :(NSString*)newHostName;

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

LocalHost Property (IPInfo Module)

This property includes the name of the local host.

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=localHost) NSString* localHost;

- (NSString*)localHost;

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.

NodeType Property (IPInfo Module)

This property includes the type of node for the system.

Syntax

• Swift
• Objective-C

public var nodeType: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=nodeType) NSString* nodeType;

- (NSString*)nodeType;

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.

OtherAddresses Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var otherAddresses: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=otherAddresses) NSString* otherAddresses;

- (NSString*)otherAddresses;

Default Value

""

Remarks

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

This property is read-only.

OtherDNSServers Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var otherDNSServers: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=otherDNSServers) NSString* otherDNSServers;

- (NSString*)otherDNSServers;

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.

PendingRequests Property (IPInfo Module)

This property includes the number of requests awaiting completion.

Syntax

• Swift
• Objective-C

public var pendingRequests: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=pendingRequests,setter=setPendingRequests:) int pendingRequests;

- (int)pendingRequests;
- (void)setPendingRequests :(int)newPendingRequests;

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.

RequestId Property (IPInfo Module)

This property includes the handle of the last request.

Syntax

• Swift
• Objective-C

public var requestId: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=requestId) int requestId;

- (int)requestId;

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.

RoutingEnabled Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var routingEnabled: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=routingEnabled) BOOL routingEnabled;

- (BOOL)routingEnabled;

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.

ServiceAliases Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var serviceAliases: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=serviceAliases) NSString* serviceAliases;

- (NSString*)serviceAliases;

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.

ServiceName Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var serviceName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=serviceName,setter=setServiceName:) NSString* serviceName;

- (NSString*)serviceName;
- (void)setServiceName :(NSString*)newServiceName;

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.

ServicePort Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var servicePort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=servicePort,setter=setServicePort:) int servicePort;

- (int)servicePort;
- (void)setServicePort :(int)newServicePort;

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.

ServiceProtocol Property (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public var serviceProtocol: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=serviceProtocol,setter=setServiceProtocol:) NSString* serviceProtocol;

- (NSString*)serviceProtocol;
- (void)setServiceProtocol :(NSString*)newServiceProtocol;

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.

Config Method (IPInfo Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DHCPRelease Method (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public func DHCPRelease() throws -> Void

- (void)DHCPRelease;

Remarks

This method releases the IP address of the current adapter specified by AdapterIndex. If AdapterDHCPEnabled is True, the lease of the IP address assigned to the current adapter specified by AdapterIndex is released.

Note: This functionality is only available in Windows.

DHCPRenew Method (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public func DHCPRenew() throws -> Void

- (void)DHCPRenew;

Remarks

This method renews the IP address of the current adapter specified by AdapterIndex. If AdapterDHCPEnabled is True, the lease of the IP address assigned to the current adapter specified by AdapterIndex is renewed.

Note: This functionality is only available in Windows.

DisplayDNSCache Method (IPInfo Module)

This method displays cached DNS entries.

Syntax

• Swift
• Objective-C

public func displayDNSCache() throws -> String

- (NSString*)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.

DoEvents Method (IPInfo Module)

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

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

FlushDNSCache Method (IPInfo Module)

This method flushes the DNS cache.

Syntax

• Swift
• Objective-C

public func flushDNSCache() throws -> Bool

- (BOOL)flushDNSCache;

Remarks

This method flushes the DNS cache for the system.

Note: This functionality is only available in Windows.

GetMAC Method (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public func getMAC(ipAddress: String) throws -> String

- (NSString*)getMAC:(NSString*)IPAddress;

Remarks

This method returns the unique Media Access Control (MAC) address of the network interface at IPAddress.

Note: This functionality is only available in Windows.

Reset Method (IPInfo Module)

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

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

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

ResolveAddress Method (IPInfo Module)

This method resolves an IP address.

Syntax

• Swift
• Objective-C

public func resolveAddress(hostAddress: String) throws -> String

- (NSString*)resolveAddress:(NSString*)hostAddress;

Remarks

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

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

Example. Resolve an Address:

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

ResolveName Method (IPInfo Module)

This method resolves a host name.

Syntax

• Swift
• Objective-C

public func resolveName(hostName: String) throws -> String

- (NSString*)resolveName:(NSString*)hostName;

Remarks

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

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

Example. Resolve a Name:

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

DNSCacheEntry Event (IPInfo Module)

This event fires once for each cached DNS entry.

Syntax

• Swift
• Objective-C

func onDNSCacheEntry(recordName: String, recordType: Int32, timeToLive: Int32, dataLength: Int32, section: String, recordValue: String, recordInfo: String)

- (void)onDNSCacheEntry:(NSString*)recordName :(int)recordType :(int)timeToLive :(int)dataLength :(NSString*)section :(NSString*)recordValue :(NSString*)recordInfo;

Remarks

This event fires once for each entry in the local DNS cache when DisplayDNSCache is called.

RecordName is the host name to which the record applies.

RecordType is the type of response. For instance 1 is an A record.

TimeToLive is the time in seconds after which the cached entry expires.

DataLength is the length of the data in bytes. For instance, if the RecordType is A and an IPv4 address is cached, its DataLength would be 4. CNAME and PTR records will contain the length of the address in memory where the value is held.

Section is the section of the DNS response from which the record is taken. Most commonly, this is the "Answer" section.

RecordValue is the actual value that is cached. For instance this may be an IP address for A records.

RecordInfo is a text representation of the other parameters. This is suitable for use in a log file or to display.

Error Event (IPInfo Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

This event is fired after an asynchronous request completes.

Syntax

• Swift
• Objective-C

func onRequestComplete(requestId: Int32, statusCode: Int32, description: String)

- (void)onRequestComplete:(int)requestId :(int)statusCode :(NSString*)description;

Remarks

The RequestId parameter specifies the request that just completed. The class properties that relate to this request are completed with the returned values. For example, in the case of domain name resolution, HostName, HostAddress, HostAliases, and OtherAddresses are set to the resolved values.

If the request completed normally, StatusCode is 0, and Description is "OK". If not, StatusCode has the error code returned by the system. Description contains a description of this code.

Please refer to the Error Codes section for more information.

Note: This functionality is only available in Windows.

Config Settings (IPInfo Module)

IPInfo Config Settings

Base Config Settings

Trappable Errors (IPInfo Module)

IPInfo Errors

SSL Errors

TCP/IP Errors