ICMP Control

Properties Methods Events Config Settings Errors

The ICMP control is used to facilitate ICMP communications. It can act both as a client and a server and can communicate with any number of hosts simultaneously. It also can generate and receive broadcast packets.

Syntax

ICMP

Remarks

The interface of the control is similar to the interface of TCPClient, only it is much simpler. The control is activated/deactivated by using the Active property. This property enables or disables the sending or receiving of data. Data can be sent in the same way as TCPClient, using the Send method and Text parameter. The destination is specified using the RemoteHost property. The control automatically creates an ICMP header containing MessageType, MessageSubType, and a checksum for the message.

If the UseConnection configuration setting is set to True, then a local association is created with the remote host. Otherwise, the control can receive datagrams (packets) from any host and can send datagrams to any host. Packets can be broadcast on the local net by setting the destination to 255.255.255.255.

Inbound data is received through the DataIn event.

The operation of the control is almost completely asynchronous. All the calls, except the ones that deal with domain name resolution, operate through Windows messages (no blocking calls). The gain in performance is considerable when compared with using blocking calls.

Property List

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


AcceptData	This property indicates whether data reception is currently enabled.
Active	This property indicates whether the control is active.
DontRoute	If this property is set to True, it forces the socket to send data directly to the interface (no routing).
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageSubType	This property is the subtype of the ICMP message (part of the ICMP header).
MessageType	This property includes the type of the ICMP message (part of the ICMP header).
RemoteHost	This property includes the address of the RemoteHost. Domain names are resolved to IP addresses.
Timeout	This property specifies the timeout for the control.
TimeToLive	This property includes the time-to-live (TTL) value for the ICMP packets sent by the control.

Method List

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


Activate	This method enables sending and receiving of data.
Config	Sets or retrieves a configuration setting.
Deactivate	This method disables sending and receiving of data.
DoEvents	This method processes events from the internal message queue.
PauseData	This method pauses data reception.
ProcessData	This method reenables data reception after a call to PauseData .
Reset	This method will reset the control.
ResolveRemoteHost	This method resolves the hostname in RemoteHost to an IP address.
Send	This method sends data to the remote host.
SendBytes	This method sends data to the remote host.
SendText	This method sends data to the remote host.

Event List

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


DataIn	This event is fired when a new ICMP messages come in.
Error	Fired when information is available about errors during data delivery.
ReadyToSend	This event is fired when the control is ready to send data.

Config Settings

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


DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
DontFragment	Whether the DontFragment control flag is set.
IcmpDllTimeout	The timeout for the control when using the icmp.dll.
MaxMessageSize	The maximum length of the messages that can be received.
MulticastTTL	The time to live (TTL) value for multicast ICMP packets sent by the control.
ReceiveAllMode	Enables a socket to receive all IPv4 or IPv6 packets on the network.
TimeoutInMilliseconds	The timeout is treated as milliseconds.
UseConnection	Determines whether to use a connected socket.
UseICMPDLL	Use the icmp.dll included on Windows Systems.
UseIPHLPDLL	Use the iphlpapi.dll included on Windows Systems.
UseIPv6	Whether to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

AcceptData Property (ICMP Control)

This property indicates whether data reception is currently enabled.

Syntax

icmpcontrol.AcceptData

Default Value

True

Remarks

This property indicates whether data reception is currently enabled. When , data reception is disabled and the DataIn event will not fire. Use the PauseData and ProcessData methods to pause and resume data reception.

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

Data Type

Boolean

Active Property (ICMP Control)

This property indicates whether the control is active.

Syntax

icmpcontrol.Active

Default Value

False

Remarks

This property indicates whether the control is currently active and can send or receive data.

If the UseConnection configuration setting is set to , then a local association (connection) to the remote host also is created. Use the Activate and Deactivate methods to control whether the control is active.

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

Data Type

Boolean

DontRoute Property (ICMP Control)

If this property is set to True, it forces the socket to send data directly to the interface (no routing).

Syntax

icmpcontrol.DontRoute[=boolean]

Default Value

False

Remarks

If this property is set to True, it forces the socket to send data directly to the interface (no routing). Normally, IP sockets send packets of data through routers and gateways until they reach the final destination. If this property is set to True, then data will be delivered on the local subnet only.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (ICMP Control)

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

Syntax

icmpcontrol.LocalHost[=string]

Default Value

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control 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 multihomed 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.

Data Type

String

MessageSubType Property (ICMP Control)

This property is the subtype of the ICMP message (part of the ICMP header).

Syntax

icmpcontrol.MessageSubType[=integer]

Default Value

Remarks

This property contains the subtype of the ICMP message (part of the ICMP header). The ICMP message subtype (also referred to as "code") is a byte value representing the message subclass. Its meaning is associated with the MessageType.

Types and subtypes of ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP)/IP.

Data Type

Integer

MessageType Property (ICMP Control)

This property includes the type of the ICMP message (part of the ICMP header).

Syntax

icmpcontrol.MessageType[=integer]

Default Value

Remarks

This property contains the type of the ICMP message (part of the ICMP header). The ICMP message type is a byte value representing the message class. The message type defines the structure and meaning of the message data assigned to Text parameter of the Send method.

Types for ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP/IP). The following are a few examples of ICMP message types:


0	Echo reply ("ping" reply).
3	Destination unreachable.
4	Source quench.
5	Redirect (change a route).
8	Echo request ("ping" request).
11	Time exceeded for datagram.
12	Parameter problem on datagram.
13	Timestamp request.
14	Timestamp reply.
17	Address mask request.
18	Address mask reply.

Data Type

Integer

RemoteHost Property (ICMP Control)

This property includes the address of the RemoteHost. Domain names are resolved to IP addresses.

Syntax

icmpcontrol.RemoteHost[=string]

Default Value

Remarks

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

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

If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, the control fails with an error.

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

Data Type

String

Timeout Property (ICMP Control)

This property specifies the timeout for the control.

Syntax

icmpcontrol.Timeout[=integer]

Default Value

Remarks

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

If Timeout is set to a positive value, the control will automatically retry each operation that otherwise would result in a WOULDBLOCK error for a maximum of Timeout seconds.

The control 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 control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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 0 (asynchronous operation).

Data Type

Integer

TimeToLive Property (ICMP Control)

This property includes the time-to-live (TTL) value for the ICMP packets sent by the control.

Syntax

icmpcontrol.TimeToLive[=integer]

Default Value

Remarks

This method contains the time-to-live (TTL) value for the ICMP packets sent by the control. The 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 value is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL value is reduced to zero (or less), the packet is discarded.

If the value of the property is set to zero, then the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.

This property is not available at design time.

Data Type

Integer

Activate Method (ICMP Control)

This method enables sending and receiving of data.

Syntax

icmpcontrol.Activate

Remarks

This method enables sending and receiving of data. When called, the control will create a communication endpoint (socket) that can be used for sending and receiving ICMP messages. This method must be called before using the control to send and receive data.

If the UseConnection configuration setting is set to , then a local association (connection) to the remote host also is created.

Config Method (ICMP Control)

Sets or retrieves a configuration setting.

Syntax

icmpcontrol.Config ConfigurationString

Remarks

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

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

This method disables sending and receiving of data.

Syntax

icmpcontrol.Deactivate

Remarks

This method disables sending and receiving of data. When called, the control will destroy the existing socket and disable data communications.

DoEvents Method (ICMP Control)

This method processes events from the internal message queue.

Syntax

icmpcontrol.DoEvents

Remarks

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

PauseData Method (ICMP Control)

This method pauses data reception.

Syntax

icmpcontrol.PauseData

Remarks

This method pauses data reception when called. While data reception is paused, the DataIn event will not fire. Call ProcessData to reenable data reception.

ProcessData Method (ICMP Control)

This method reenables data reception after a call to PauseData .

Syntax

icmpcontrol.ProcessData

Remarks

This method reenables data reception after a previous call to PauseData. When PauseData is called, the DataIn event will not fire. To reenable data reception and allow DataIn to fire, call this method.

Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.

Reset Method (ICMP Control)

This method will reset the control.

Syntax

icmpcontrol.Reset

Remarks

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

ResolveRemoteHost Method (ICMP Control)

This method resolves the hostname in RemoteHost to an IP address.

Syntax

icmpcontrol.ResolveRemoteHost

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 control will resolve the hostname automatically when needed. If DelayHostResolution is , this method may be called to manually resolve RemoteHost, if desired.

Send Method (ICMP Control)

This method sends data to the remote host.

Syntax

icmpcontrol.Send Text

Remarks

This method sends data to the remote host.

SendBytes Method (ICMP Control)

This method sends data to the remote host.

Syntax

icmpcontrol.SendBytes Data

Remarks

This method sends data to the remote host. Calling this method is equivalent to calling the SendBytes/SendText method.

SendText Method (ICMP Control)

This method sends data to the remote host.

Syntax

icmpcontrol.SendText Text

Remarks

This method sends data to the remote host. Calling this method is equivalent to calling the SendBytes/SendText method.

DataIn Event (ICMP Control)

This event is fired when a new ICMP messages come in.

Syntax

Sub icmpcontrol_DataIn(MessageType As Integer, MessageSubType As Integer, MessageData As String, Checksum As Integer, SourceAddress As String)

Remarks

The MessageType parameter shows the type of the ICMP messages and the MessageSubType parameter shows its subtype.

The MessageData parameter contains the message data.

The Checksum parameter is True or False depending on the ICMP checksum validation on the message.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Error Event (ICMP Control)

Fired when information is available about errors during data delivery.

Syntax

Sub icmpcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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.

ReadyToSend Event (ICMP Control)

This event is fired when the control is ready to send data.

Syntax

Sub icmpcontrol_ReadyToSend()

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed Send.

Config Settings (ICMP Control)

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

ICMP Config Settings

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

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

The default value is .

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 control when using the icmp.dll.

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

The default value for IcmpDllTimeout is 60 seconds.

Note: This configuration setting is valid only 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 control 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 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 Transmission Control Protocol (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. The following modes are available:


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

TimeoutInMilliseconds: The timeout is treated as milliseconds.

Setting TimeoutInMilliseconds to True causes the control to use the value in the IcmpDllTimeout configuration setting as milliseconds instead of seconds, which is the default.

Note: This setting is valid only when UseICMPDLL is set to True.

UseConnection: Determines whether to use a connected socket.

UseConnection specifies whether or not the control should use a connected socket. 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 Transmission Control Protocol (TCP) sense. It means only that the control will send and receive data 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 control to use the icmp.dll on Windows 9x or on 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 control to use the iphlpapi.dll on Windows XP or on later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited.

Note: If both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the control will use IPv4 exclusively. When set to 1, the control will use IPv6 exclusively. To instruct the control 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 as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

Socket Config Settings

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

If AbsoluteTimeout is set to True, any method that 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 User Datagram Protocol (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 Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control 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. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

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

Base Config Settings

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (ICMP Control)

ICMP Errors

20105	The control is already Active.
20108	Cannot change the LocalHost at this time. A connection is in progress.
20110	The control must be Active for this operation.
20113	Cannot change MaxMessageSize while ICMP is Active.
20115	Cannot change RemoteHost when UseConnection is set and the control is Active.
20118	Cannot change UseConnection while the control is Active.
20119	The message cannot be longer than MaxMessageSize.
20120	The message is too short.
20121	Cannot create ICMP handle.

SSL Errors

20271	Cannot load specified security library.
20272	Cannot open certificate store.
20273	Cannot find specified certificate.
20274	Cannot acquire security credentials.
20275	Cannot find certificate chain.
20276	Cannot verify certificate chain.
20277	Error during handshake.
20281	Error verifying certificate.
20282	Could not find client certificate.
20283	Could not find server certificate.
20284	Error encrypting data.
20285	Error decrypting data.

TCP/IP Errors

25005	[10004] Interrupted system call.
25010	[10009] Bad file number.
25014	[10013] Access denied.
25015	[10014] Bad address.
25023	[10022] Invalid argument.
25025	[10024] Too many open files.
25036	[10035] Operation would block.
25037	[10036] Operation now in progress.
25038	[10037] Operation already in progress.
25039	[10038] Socket operation on nonsocket.
25040	[10039] Destination address required.
25041	[10040] Message is too long.
25042	[10041] Protocol wrong type for socket.
25043	[10042] Bad protocol option.
25044	[10043] Protocol is not supported.
25045	[10044] Socket type is not supported.
25046	[10045] Operation is not supported on socket.
25047	[10046] Protocol family is not supported.
25048	[10047] Address family is not supported by protocol family.
25049	[10048] Address already in use.
25050	[10049] Cannot assign requested address.
25051	[10050] Network is down.
25052	[10051] Network is unreachable.
25053	[10052] Net dropped connection or reset.
25054	[10053] Software caused connection abort.
25055	[10054] Connection reset by peer.
25056	[10055] No buffer space available.
25057	[10056] Socket is already connected.
25058	[10057] Socket is not connected.
25059	[10058] Cannot send after socket shutdown.
25060	[10059] Too many references, cannot splice.
25061	[10060] Connection timed out.
25062	[10061] Connection refused.
25063	[10062] Too many levels of symbolic links.
25064	[10063] File name is too long.
25065	[10064] Host is down.
25066	[10065] No route to host.
25067	[10066] Directory is not empty
25068	[10067] Too many processes.
25069	[10068] Too many users.
25070	[10069] Disc Quota Exceeded.
25071	[10070] Stale NFS file handle.
25072	[10071] Too many levels of remote in path.
25092	[10091] Network subsystem is unavailable.
25093	[10092] WINSOCK DLL Version out of range.
25094	[10093] Winsock is not loaded yet.
26002	[11001] Host not found.
26003	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
26004	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
26005	[11004] Valid name, no data record (check DNS setup).