TraceRoute Class
Properties Methods Events Config Settings Errors
The TraceRoute class allows you to trace the path that the IP packets take on the Internet.
Class Name
IPWorks_TraceRoute
Procedural Interface
ipworks_traceroute_open(); ipworks_traceroute_close($res); ipworks_traceroute_register_callback($res, $id, $function); ipworks_traceroute_get_last_error($res); ipworks_traceroute_get_last_error_code($res); ipworks_traceroute_set($res, $id, $index, $value); ipworks_traceroute_get($res, $id, $index); ipworks_traceroute_do_config($res, $configurationstring); ipworks_traceroute_do_doevents($res); ipworks_traceroute_do_interrupt($res); ipworks_traceroute_do_reset($res); ipworks_traceroute_do_resolveremotehost($res); ipworks_traceroute_do_traceto($res, $host);
Remarks
The component implements a standard IP TraceRoute as defined in RFC 1393.
To use the class, simply call the TraceTo method and set the Host parameter to the domain name or IP address of the host you want to trace the path to. This is identical to setting the RemoteHost property to the domain name or IP address. The class will start sending probe packets toward the host, and as it receives replies, it will fire Hop events giving information about the route. The same information is also provided in the Hops properties.
The ResolveNames property enables or disables DNS resolution of IP addresses received during the trace. If set to False, only IP addresses are provided. If set to True, the class will attempt to resolve the names of the hosts in the route. This may considerably increase the time it takes to complete the trace.
The HopTimeout property determines the maximum waiting time for a response in each hop of the trace, while the Timeout property defines the maximum waiting time for the whole trace. The HopLimit property specifies the maximum number of hops allowed for a trace.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
HopLimit | This property includes the maximum number of hops to allow for a trace. |
HopCount | The number of records in the Hop arrays. |
HopErrorCode | This property contains the error code for a particular hop in the trace. |
HopErrorDescription | This property contains the error description for a particular hop in the trace. |
HopHostAddress | This property contains the IP address of the host for a particular hop in the trace. |
HopHostName | This property contains the name of the host for a particular hop in the trace. |
HopTime | This property contains the amount of time taken by a particular hop in the trace. |
HopTimeout | This property includes the maximum amount of time to wait for an individual hop to complete. |
Idle | This property specifies the current status of the class. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
RemoteHost | This property includes the address of a host to trace to. |
ResolveNames | This property determines whether the class resolves the host name for each host during the trace. |
Timeout | This property includes the timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoEvents | This method processes events from the internal message queue. |
Interrupt | This method interrupts the current method. |
Reset | This method will reset the class. |
ResolveRemoteHost | This method resolves the hostname in RemoteHost to an IP address. |
TraceTo | This method traces the route to a host. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Fired when information is available about errors during data delivery. |
Hop | This event is fired for each hop in the trace to the RemoteHost . |
HopResolved | This event is fired when the name of a hop address is found. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
HopTimeoutInMilliseconds | The hop timeout is treated as milliseconds. |
TimeoutInMilliseconds | The timeout is treated as milliseconds. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DontFragment | Whether the DontFragment control flag is set. |
IcmpDllTimeout | The timeout for the class 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 class. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
HopLimit Property (IPWorks_TraceRoute Class)
This property includes the maximum number of hops to allow for a trace.
Object Oriented Interface
public function getHopLimit(); public function setHopLimit($value);
Procedural Interface
ipworks_traceroute_get($res, 1 ); ipworks_traceroute_set($res, 1, $value );
Default Value
64
Remarks
This property is used to limit lengthy traces. A value of 0 indicates an unbounded trace.
Note: If the value of Timeout is 0, an unbounded trace may cause a call to TraceTo to block indefinitely. To cancel such a route trace, call Interrupt.
Data Type
Integer
HopCount Property (IPWorks_TraceRoute Class)
The number of records in the Hop arrays.
Object Oriented Interface
public function getHopCount();
Procedural Interface
ipworks_traceroute_get($res, 2 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at HopCount - 1.This property is read-only and not available at design time.
Data Type
Integer
HopErrorCode Property (IPWorks_TraceRoute Class)
This property contains the error code for a particular hop in the trace.
Object Oriented Interface
public function getHopErrorCode($hopindex);
Procedural Interface
ipworks_traceroute_get($res, 3 , $hopindex);
Default Value
0
Remarks
This property contains the error code for a particular hop in the trace.
For a list of valid error codes and their descriptions, please refer to the Error Messages section.
The $hopindex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.
This property is read-only and not available at design time.
Data Type
Integer
HopErrorDescription Property (IPWorks_TraceRoute Class)
This property contains the error description for a particular hop in the trace.
Object Oriented Interface
public function getHopErrorDescription($hopindex);
Procedural Interface
ipworks_traceroute_get($res, 4 , $hopindex);
Default Value
''
Remarks
This property contains the error description for a particular hop in the trace.
For a list of valid error codes and their descriptions, please refer to the Error Messages section.
The $hopindex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.
This property is read-only and not available at design time.
Data Type
String
HopHostAddress Property (IPWorks_TraceRoute Class)
This property contains the IP address of the host for a particular hop in the trace.
Object Oriented Interface
public function getHopHostAddress($hopindex);
Procedural Interface
ipworks_traceroute_get($res, 5 , $hopindex);
Default Value
''
Remarks
This property contains the IP address of the host for a particular hop in the trace.
The $hopindex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.
This property is read-only and not available at design time.
Data Type
String
HopHostName Property (IPWorks_TraceRoute Class)
This property contains the name of the host for a particular hop in the trace.
Object Oriented Interface
public function getHopHostName($hopindex);
Procedural Interface
ipworks_traceroute_get($res, 6 , $hopindex);
Default Value
''
Remarks
This property contains the name of the host for a particular hop in the trace.
If ResolveNames is False, this property contains the IP address of the host instead.
The $hopindex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.
This property is read-only and not available at design time.
Data Type
String
HopTime Property (IPWorks_TraceRoute Class)
This property contains the amount of time taken by a particular hop in the trace.
Object Oriented Interface
public function getHopTime($hopindex);
Procedural Interface
ipworks_traceroute_get($res, 7 , $hopindex);
Default Value
0
Remarks
This property contains the amount of time taken by a particular hop in the trace.
If a given hop times out, this value will be set to -1.
The $hopindex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.
This property is read-only and not available at design time.
Data Type
Integer
HopTimeout Property (IPWorks_TraceRoute Class)
This property includes the maximum amount of time to wait for an individual hop to complete.
Object Oriented Interface
public function getHopTimeout(); public function setHopTimeout($value);
Procedural Interface
ipworks_traceroute_get($res, 8 ); ipworks_traceroute_set($res, 8, $value );
Default Value
10
Remarks
The time value is in seconds. If 0, HopTimeout will be ignored, and only the Timeout for the whole trace will be taken into account.
Data Type
Integer
Idle Property (IPWorks_TraceRoute Class)
This property specifies the current status of the class.
Object Oriented Interface
public function getIdle();
Procedural Interface
ipworks_traceroute_get($res, 9 );
Default Value
true
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
LocalHost Property (IPWorks_TraceRoute Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworks_traceroute_get($res, 10 ); ipworks_traceroute_set($res, 10, $value );
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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) 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 class 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
RemoteHost Property (IPWorks_TraceRoute Class)
This property includes the address of a host to trace to.
Object Oriented Interface
public function getRemoteHost(); public function setRemoteHost($value);
Procedural Interface
ipworks_traceroute_get($res, 11 ); ipworks_traceroute_set($res, 11, $value );
Default Value
''
Remarks
Traces are initiated by setting RemoteHost to the name or address of the host to trace to.
This property must contain a valid Internet domain name or address or an error will be returned.
To interrupt a trace in progress, set RemoteHost to empty string.
Example. Perform a TraceRoute:
TraceRouteControl.TraceTo("myHost")
is equivalent to
TraceRouteControl.RemoteHost = "myHost"
Data Type
String
ResolveNames Property (IPWorks_TraceRoute Class)
This property determines whether the class resolves the host name for each host during the trace.
Object Oriented Interface
public function getResolveNames(); public function setResolveNames($value);
Procedural Interface
ipworks_traceroute_get($res, 12 ); ipworks_traceroute_set($res, 12, $value );
Default Value
false
Remarks
This property determines whether the class resolves the name of host at each "hop" during the trace. The default value is False.
Note: If this property is set to True, the trace takes longer because of name resolution.
Data Type
Boolean
Timeout Property (IPWorks_TraceRoute Class)
This property includes the timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworks_traceroute_get($res, 13 ); ipworks_traceroute_set($res, 13, $value );
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class 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 class 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 60 seconds.
Data Type
Integer
Config Method (IPWorks_TraceRoute Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworks_traceroute_do_config($res, $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.
DoEvents Method (IPWorks_TraceRoute Class)
This method processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworks_traceroute_do_doevents($res);
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.
Interrupt Method (IPWorks_TraceRoute Class)
This method interrupts the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworks_traceroute_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Reset Method (IPWorks_TraceRoute Class)
This method will reset the class.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworks_traceroute_do_reset($res);
Remarks
This method will reset the class's properties to their default values.
ResolveRemoteHost Method (IPWorks_TraceRoute Class)
This method resolves the hostname in RemoteHost to an IP address.
Object Oriented Interface
public function doResolveRemoteHost();
Procedural Interface
ipworks_traceroute_do_resolveremotehost($res);
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 class will resolve the hostname automatically when needed. If DelayHostResolution is true, this method may be called to manually resolve RemoteHost, if desired.
TraceTo Method (IPWorks_TraceRoute Class)
This method traces the route to a host.
Object Oriented Interface
public function doTraceTo($host);
Procedural Interface
ipworks_traceroute_do_traceto($res, $host);
Remarks
Traces are initiated by calling TraceTo, with the Host argument set to the name or address of the destination host to trace to. Host must contain a valid Internet domain name or address, or the class fails with an error. To interrupt a trace in progress, set RemoteHost to empty string. Calling this method is equivalent to setting the RemoteHost property to Host.
Example. Perform a TraceRoute:
TraceRouteControl.TraceTo("myHost")
is equivalent to
TraceRouteControl.RemoteHost = "myHost"
Error Event (IPWorks_TraceRoute Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworks_traceroute_register_callback($res, 1, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Hop Event (IPWorks_TraceRoute Class)
This event is fired for each hop in the trace to the RemoteHost .
Object Oriented Interface
public function fireHop($param);
Procedural Interface
ipworks_traceroute_register_callback($res, 2, array($this, 'fireHop'));
Parameter List
'hopnumber'
'hostaddress'
'duration'
Remarks
This event provides access to the information for each hop in the trace. The HopNumber parameter denotes which hop the trace is at. The HostAddress parameter is the IP address of the host for the hop identified by HopNumber. The Duration parameter shows the amount of time taken by the hop.
HopResolved Event (IPWorks_TraceRoute Class)
This event is fired when the name of a hop address is found.
Object Oriented Interface
public function fireHopResolved($param);
Procedural Interface
ipworks_traceroute_register_callback($res, 3, array($this, 'fireHopResolved'));
Parameter List
'hopnumber'
'statuscode'
'hophostname'
Remarks
The StatusCode contains 0 if the address is resolved successfully, or an error code, in which case, HopHostName contains a textual description of the error.
Host name resolution is disabled by default. Set ResolveNames to True to enable it.
Config Settings (TraceRoute Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
TraceRoute Config Settings
The default value is false.
ICMP Config Settings
The default value is false.
The default value is False.
The default value for IcmpDllTimeout is 60 seconds.
Note: This configuration setting is valid only when UseICMPDLL is set to True.
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.
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. |
Note: This setting is valid only when UseICMPDLL is set to True.
The default value for this setting is False.
Note: If both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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
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 |
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 |
- 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).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (TraceRoute Class)
TraceRoute Errors
131 | Request queue is full. |
132 | Message for unknown request. |
134 | Invalid address string. |
159 | Invalid hop index (out of range). |
301 | Timeout. |
17302 | Hop timed out. |
17312 | Busy performing current trace. |
The class may also return one of the following error codes, which are inherited from other classes.
ICMP Errors
104 | The class is already Active. |
107 | Cannot change the LocalHost at this time. A connection is in progress. |
109 | The class must be Active for this operation. |
112 | Cannot change MaxMessageSize while ICMP is Active. |
114 | Cannot change RemoteHost when UseConnection is set and the class is Active. |
117 | Cannot change UseConnection while the class is Active. |
118 | The message cannot be longer than MaxMessageSize. |
119 | The message is too short. |
120 | Cannot 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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot 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] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is 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 is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |