Docs

IPWorks 2022 .NET Edition

Version 22.0 [Build 8171]

Ping Component

Properties   Methods   Events   Configuration Settings   Errors  

The Ping component encapsulates ICMP ECHO functionality, used to check whether there is a communications link between two computers.

Syntax

nsoftware.IPWorks.Ping

Remarks

When the PingHost method is called with the Host parameter, or RemoteHost is assigned an IP address or domain name, the component sends an ICMP ECHO packet to the remote host. The ResponseTime and ResponseSource properties are updated with the time of the roundtrip to the remote host, and the address of the host actually sending the response.

The component operates synchronously by default (waits for a response before returning control to the caller), however, the component may also operate asynchronously (return control immediately), by setting Timeout to 0. Please refer to the Timeout property for more information.

Property List


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

ActiveEnables or disables receiving of data.
IdleThe current status of the component.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
PacketSizeThe size of the packet to send as the ping request.
RemoteHostThe address of the RemoteHost. Domain names are resolved to IP addresses.
RequestIdA unique identifier for outgoing packets.
ResponseSourceThe source of the last PING response.
ResponseStatusThe status of the last PING response.
ResponseTimeTime elapsed between sending the original packet and the remote host reply.
TimeoutA timeout for the component.
TimeToLiveThe time to live (TTL) value for the ICMP packets sent by the component.
TypeOfServiceThe type of the ICMP message sent as a ping request.

Method List


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

ActivateEnables sending and receiving data.
ConfigSets or retrieves a configuration setting.
DeactivateDisables sending and receiving data.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
PingHostPings a host.
ResetReset the component.
ResolveRemoteHostResolves the hostname in RemoteHost to an IP address.
WakeOnLANSends a Wake-On-LAN packet.

Event List


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

ErrorInformation about errors during data delivery.
ResponseFired when a response packet is received.

Configuration Settings


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

DataCharValueThe character value used to populate the data of the ICMP packet.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
QOSDSCPValueThe raw value of DSCP portion in the IP header.
ResponseStatusThe status of the last received response.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
DontFragmentWhether the DontFragment control flag is set.
IcmpDllTimeoutThe timeout for the component when using the icmp.dll.
MaxMessageSizeThe maximum length of the messages that can be received.
MulticastTTLThe time to live (TTL) value for multicast ICMP packets sent by the component.
ReceiveAllModeEnables a socket to receive all IPv4 or IPv6 packets on the network.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
UseConnectionDetermines whether to use a connected socket.
UseICMPDLLUse the icmp.dll included on Windows Systems.
UseIPHLPDLLUse the iphlpapi.dll included on Windows Systems.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Active Property (Ping Component)

Enables or disables receiving of data.

Syntax

public bool Active { get; set; }
Public Property Active As Boolean

Default Value

False

Remarks

This property enables or disables receiving of data. Setting this property to True makes the component able to accept data. If this property is False, the component will not receive incoming data.

The PingHost method will automatically change the value of this property to True.

Note: It is recommended to use the Activate or Deactivate method instead of setting this property.

This property is not available at design time.

Idle Property (Ping Component)

The current status of the component.

Syntax

public bool Idle { get; }
Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

LocalHost Property (Ping Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

public string LocalHost { get; set; }
Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

PacketSize Property (Ping Component)

The size of the packet to send as the ping request.

Syntax

public int PacketSize { get; set; }
Public Property PacketSize As Integer

Default Value

64

Remarks

This property allows you to control the size of the data packet sent in the PingHost method. The default packet size is 64 bytes, with a minimum of 8 bytes (4 bytes of the ICMP header + ECHO identifier). The maximum value is 65520.

RemoteHost Property (Ping Component)

The address of the RemoteHost. Domain names are resolved to IP addresses.

Syntax

public string RemoteHost { get; set; }
Public Property RemoteHost As String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host.

If this property is set to 255.255.255.255, the component broadcasts data on the local subnet.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, the component throws an exception.

If UseConnection is True, this property must be set before the component is activated (Active is set to True).

RequestId Property (Ping Component)

A unique identifier for outgoing packets.

Syntax

public int RequestId { get; }
Public ReadOnly Property RequestId As Integer

Default Value

0

Remarks

This property contains a unique identifier for outgoing packets. This property is useful during asynchronous ping operations. The RequestId parameter of the Response event is used to match requests with responses.

The identifier of the outgoing ping packet is provided in this property after the PingHost method returns.

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

ResponseSource Property (Ping Component)

The source of the last PING response.

Syntax

public string ResponseSource { get; }
Public ReadOnly Property ResponseSource As String

Default Value

""

Remarks

This property contains the address of the host responding to the PING (ICMP ECHO) request. This may or may not be the host used in PingHost.

This property is read-only.

ResponseStatus Property (Ping Component)

The status of the last PING response.

Syntax

public string ResponseStatus { get; }
Public ReadOnly Property ResponseStatus As String

Default Value

""

Remarks

This property contains the status of the last response. After PingHost has returned this property will be populated with the stauts of the response. For responses without error the value will be OK. In the case of an error the value will hold a description of the error such as Network Unreachable or Host Unreachable.

This property is read-only.

ResponseTime Property (Ping Component)

Time elapsed between sending the original packet and the remote host reply.

Syntax

public int ResponseTime { get; }
Public ReadOnly Property ResponseTime As Integer

Default Value

0

Remarks

This property contains the time elapsed between sending the original packet and the remote host reply. The time value is expressed in milliseconds. The lowest resolution available depends on the resolution of the clock on the host system (normally between 10ms and 20ms)..

This property is read-only.

Timeout Property (Ping Component)

A timeout for the component.

Syntax

public int Timeout { get; set; }
Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TimeToLive Property (Ping Component)

The time to live (TTL) value for the ICMP packets sent by the component.

Syntax

public int TimeToLive { get; set; }
Public Property TimeToLive As Integer

Default Value

0

Remarks

This method contains the Time-To-Live (TTL) value for the ICMP packets sent by the component. The Time-to-Live (TTL) field of the ICMP packet is a counter limiting the lifetime of a packet.

Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second, thus the TTL is effectively a hop count limit on how far a datagram can propagate through the Internet. When the TTL is reduced to zero (or less), the packet is discarded.

If the value of the property is set to 0, then the default TTL value of the underlying TCP/IP subsystem will be used.

This property is not available at design time.

TypeOfService Property (Ping Component)

The type of the ICMP message sent as a ping request.

Syntax

public int TypeOfService { get; set; }
Public Property TypeOfService As Integer

Default Value

8

Remarks

This property contains the type of the ICMP message sent as a ping request. The default value is 8 (ECHO REQUEST).

This property is not available at design time.

Activate Method (Ping Component)

Enables sending and receiving data.

Syntax

public void Activate();

Async Version
public async Task Activate();
public async Task Activate(CancellationToken cancellationToken);
Public Sub Activate()

Async Version
Public Sub Activate() As Task
Public Sub Activate(cancellationToken As CancellationToken) As Task

Remarks

This method enables sending and receiving of data.

Note: Calling the PingHost method will automatically activate the component.

Config Method (Ping Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

Deactivate Method (Ping Component)

Disables sending and receiving data.

Syntax

public void Deactivate();

Async Version
public async Task Deactivate();
public async Task Deactivate(CancellationToken cancellationToken);
Public Sub Deactivate()

Async Version
Public Sub Deactivate() As Task
Public Sub Deactivate(cancellationToken As CancellationToken) As Task

Remarks

This method disables sending and receiving of data.

DoEvents Method (Ping Component)

Processes events from the internal message queue.

Syntax

public void DoEvents();
Public Sub DoEvents()

Remarks

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

Interrupt Method (Ping Component)

Interrupt the current method.

Syntax

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

PingHost Method (Ping Component)

Pings a host.

Syntax

public void PingHost(string host);

Async Version
public async Task PingHost(string host);
public async Task PingHost(string host, CancellationToken cancellationToken);
Public Sub PingHost(ByVal Host As String)

Async Version
Public Sub PingHost(ByVal Host As String) As Task
Public Sub PingHost(ByVal Host As String, cancellationToken As CancellationToken) As Task

Remarks

This method will ping a host. A valid internet domain name or address must be specified in Host, or an error will be returned.

PING request (ICMP ECHO) is sent to Host.

Example (Ping a Host)

PingControl.PingHost("MyHostName") ResponseTime = PingControl.ResponseTime

Reset Method (Ping Component)

Reset the component.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

ResolveRemoteHost Method (Ping Component)

Resolves the hostname in RemoteHost to an IP address.

Syntax

public void ResolveRemoteHost();

Async Version
public async Task ResolveRemoteHost();
public async Task ResolveRemoteHost(CancellationToken cancellationToken);
Public Sub ResolveRemoteHost()

Async Version
Public Sub ResolveRemoteHost() As Task
Public Sub ResolveRemoteHost(cancellationToken As CancellationToken) As Task

Remarks

This method resolves the hostname specified by RemoteHost to an IP address. The resolved value is available in the RemoteHost property after this method returns.

In most cases calling this method is not necessary, the component will resolve the hostname automatically when necessary. If DelayHostResolution is true this method may be called to manually resolve RemoteHost if desired.

WakeOnLAN Method (Ping Component)

Sends a Wake-On-LAN packet.

Syntax

public void WakeOnLAN(string remoteHost, string MACAddress);

Async Version
public async Task WakeOnLAN(string remoteHost, string MACAddress);
public async Task WakeOnLAN(string remoteHost, string MACAddress, CancellationToken cancellationToken);
Public Sub WakeOnLAN(ByVal RemoteHost As String, ByVal MACAddress As String)

Async Version
Public Sub WakeOnLAN(ByVal RemoteHost As String, ByVal MACAddress As String) As Task
Public Sub WakeOnLAN(ByVal RemoteHost As String, ByVal MACAddress As String, cancellationToken As CancellationToken) As Task

Remarks

When this method is called, a "Wake-On-LAN" packet is sent to RemoteHost (which may also be a broadcast address). This has the effect of powering on the machine (if such functionality is supported by the network card on the remote machine).

The physical address of the remote host must be supplied in the MACAddress parameter.

Error Event (Ping Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PingErrorEventArgs e);

public class PingErrorEventArgs : EventArgs {
  public int ErrorCode { get; }

  public string Description { get; }

}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PingErrorEventArgs)

Public Class PingErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer

  Public ReadOnly Property Description As String

End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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.

Response Event (Ping Component)

Fired when a response packet is received.

Syntax

public event OnResponseHandler OnResponse;

public delegate void OnResponseHandler(object sender, PingResponseEventArgs e);

public class PingResponseEventArgs : EventArgs {
  public int RequestId { get; }

  public string ResponseSource { get; }

  public string ResponseStatus { get; }

  public int ResponseTime { get; }

}
Public Event OnResponse As OnResponseHandler

Public Delegate Sub OnResponseHandler(sender As Object, e As PingResponseEventArgs)

Public Class PingResponseEventArgs Inherits EventArgs
  Public ReadOnly Property RequestId As Integer

  Public ReadOnly Property ResponseSource As String

  Public ReadOnly Property ResponseStatus As String

  Public ReadOnly Property ResponseTime As Integer

End Class

Remarks

The RequestId parameter is used together with the RequestId property to match requests with responses.

ResponseStatus is set to "OK" for normal operation, or it contains an error string such as "Network unreachable", "Host unreachable", etc.

Configuration Settings (Ping Component)

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

Ping Configuration Settings

DataCharValue:   The character value used to populate the data of the ICMP packet.

Set this config to a character value. That value will be used to fill the data portion of the ICMP packet.

DelayHostResolution:   Whether the hostname is resolved when RemoteHost is set.

This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the component will resolve the hostname and the IP address will be present in the RemoteHost property. If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.

The default value is false for the default library and true for the Async library. The default value is false.

QOSDSCPValue:   The raw value of DSCP portion in the IP header.

Set this configuration setting to a value between 0 and 63 (6 bits). This raw value will be assigned to the DSCP portion of the IP header.

This functionality is supported on Windows only. Administrative privileges are required.

ResponseStatus:   The status of the last received response.

Querying this configuration setting will return the status of the last received response. Setting it does nothing.

TimeoutInMilliseconds:   The timeout is treated as milliseconds.

Setting TimeoutInMilliseconds to true causes the component to use the value in the Timeout property as milliseconds instead of seconds, which is the default.

ICMPPort Configuration Settings

DelayHostResolution:   Whether the hostname is resolved when RemoteHost is set.

This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the component will resolve the hostname and the IP address will be present in the RemoteHost property. If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.

The default value is false for the default library and true for the Async library. The default value is false.

DontFragment:   Whether the DontFragment control flag is set.

When set to true the DontFragment control flag in the IP header will be set.

The default value is false.

IcmpDllTimeout:   The timeout for the component when using the icmp.dll.

The component will wait for the operation to complete before returning control. If IcmpDllTimeout expires, and the operation is not yet complete, the component throws an exception. IcmpDllTimeout must be set to a positive value.

The default value for IcmpDllTimeout is 60 seconds.

NOTE: This setting is only valid when UseICMPDLL is set to true.

MaxMessageSize:   The maximum length of the messages that can be received.

This setting specifies the maximum size of the datagrams that the component will accept without truncation.

MulticastTTL:   The time to live (TTL) value for multicast ICMP packets sent by the component.

When sending multicast packets, the setting specifies the Time-To-Live (TTL) field. The Time-to-live (TTL) field of the ICMP packet is a counter limiting the lifetime of a packet.

Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second, thus the TTL is effectively a hop count limit on how far a datagram can propagate through the Internet. When the TTL is reduced to zero (or less), the packet is discarded.

By default, the default TTL value of the underlying TCP/IP subsystem will be used.

ReceiveAllMode:   Enables a socket to receive all IPv4 or IPv6 packets on the network.

This setting specifies the ReceiveAll mode for the socket. Available modes:

ValueDescription
-1 (default)The socket option is left unspecified.
0Do not receive all network traffic.
1Receive all network traffic. This enables promiscuous mode on the network interface card (NIC). On a LAN segment with a network hub, a NIC that supports promiscuous mode will capture all IPv4 or IPv6 traffic on the LAN, including traffic between other computers on the same LAN segment.
2Receive only socket-level network traffic (Feature may not be implemented by your Windows installation).
3Receive only IP level network traffic. This option does not enable promiscuous mode on the network interface card. This option only affects packet processing at the IP level. The NIC still receives only packets directed to its configured unicast and multicast addresses. However, a socket with this option enabled will receive not only packets directed to specific IP addresses, but will receive all the IPv4 or IPv6 packets the NIC receives.

TimeoutInMilliseconds:   The timeout is treated as milliseconds.

Setting TimeoutInMilliseconds to true causes the component to use the value in the IcmpDllTimeout config as milliseconds instead of seconds, which is the default.

NOTE: This setting is only valid when UseICMPDLL is set to true.

UseConnection:   Determines whether to use a connected socket.

UseConnection specifies whether the component should use a connected socket or not. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional TCP sense. What it means is only that the component will send and receive data only to and from the specified destination.

The default value for this setting is False.

UseICMPDLL:   Use the icmp.dll included on Windows Systems.

Setting UseICMPDLL to true causes the component to use the icmp.dll on Windows 9x or later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited.

UseIPHLPDLL:   Use the iphlpapi.dll included on Windows Systems.

Setting UseIPHLPDLL to true causes the component to use the iphlpapi.dll on Windows XP or later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited. Note that if both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

Socket Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

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.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component 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).
UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (Ping Component)

Ping Errors

102   The RemoteHost address is invalid (0.0.0.0).
127   Destination unreachable

The component may also return one of the following error codes, which are inherited from other components.

ICMPPort Errors

104   The component is already Active.
107   You cannot change the LocalHost at this time. A connection is in progress.
109   The component must be Active for this operation.
112   Cannot change MaxMessageSize while ICMPPort is Active.
114   Cannot change RemoteHost when UseConnection is set and the component is Active.
117   Cannot change UseConnection while the component is Active.
118   Message cannot be longer than MaxMessageSize.
119   Message too short.
120   Can't create ICMP handle.

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