Ping Class
Properties Methods Events Config Settings Errors
The PING class encapsulates Internet Control Message Protocol (ICMP) ECHO functionality, which is used to check whether there is a communications link between two computers.
Syntax
Ping
Remarks
When the PingHost method is called with the Host parameter, or if RemoteHost is assigned an IP address or domain name, the class 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 class operates synchronously by default (i.e., waits for a response before returning control to the caller); however, the class may also operate asynchronously (i.e., returns 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 class with short descriptions. Click on the links for further details.
Active | This property indicates whether the class is active. |
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. |
PacketSize | This property includes the size of the packet to send as the ping request. |
RemoteHost | This property includes the address of the RemoteHost. Domain names are resolved to IP addresses. |
RequestId | This property includes a unique identifier for outgoing packets. |
ResponseSource | This property includes the source of the last PING response. |
ResponseStatus | This property includes the status of the last PING response. |
ResponseTime | This property includes the time elapsed between sending the original packet and the remote host reply. |
Timeout | This property includes the timeout for the class. |
TimeToLive | This property includes the time-to-live (TTL) value for the ICMP packets sent by the class. |
TypeOfService | This property includes the type of ICMP message sent as a ping request. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Activate | This method enables sending and receiving data. |
Config | Sets or retrieves a configuration setting. |
Deactivate | This method disables sending and receiving data. |
DoEvents | This method processes events from the internal message queue. |
Interrupt | This method interrupts the current method. |
PingHost | This method pings a host. |
Reset | This method will reset the class. |
ResolveRemoteHost | This method resolves the hostname in RemoteHost to an IP address. |
WakeOnLAN | This method sends a Wake-On-LAN packet. |
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. |
Response | This event is fired when a response packet is received. |
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. |
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. |
Active Property (Ping Class)
This property indicates whether the class is active.
Syntax
ANSI (Cross Platform) int GetActive(); Unicode (Windows) BOOL GetActive();
int ipworks_ping_getactive(void* lpObj);
bool GetActive();
Default Value
FALSE
Remarks
This property indicates whether the class is currently active and can send or receive data. Use the Activate and Deactivate methods to control whether the class is active.
The PingHost method will automatically change the value of this property to True.
This property is read-only and not available at design time.
Data Type
Boolean
Idle Property (Ping Class)
This property specifies the current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int ipworks_ping_getidle(void* lpObj);
bool GetIdle();
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 (Ping Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworks_ping_getlocalhost(void* lpObj);
int ipworks_ping_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
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
PacketSize Property (Ping Class)
This property includes the size of the packet to send as the ping request.
Syntax
ANSI (Cross Platform) int GetPacketSize();
int SetPacketSize(int iPacketSize); Unicode (Windows) INT GetPacketSize();
INT SetPacketSize(INT iPacketSize);
int ipworks_ping_getpacketsize(void* lpObj);
int ipworks_ping_setpacketsize(void* lpObj, int iPacketSize);
int GetPacketSize();
int SetPacketSize(int iPacketSize);
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 plus the ECHO identifier). The maximum value is 65520.
Data Type
Integer
RemoteHost Property (Ping Class)
This property includes the address of the RemoteHost. Domain names are resolved to IP addresses.
Syntax
ANSI (Cross Platform) char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost); Unicode (Windows) LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);
char* ipworks_ping_getremotehost(void* lpObj);
int ipworks_ping_setremotehost(void* lpObj, const char* lpszRemoteHost);
QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);
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 class 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 class fails with an error.
If UseConnection is True, this property must be set before the class is activated (Active is set to True).
Data Type
String
RequestId Property (Ping Class)
This property includes a unique identifier for outgoing packets.
Syntax
ANSI (Cross Platform) int GetRequestId(); Unicode (Windows) INT GetRequestId();
int ipworks_ping_getrequestid(void* lpObj);
int GetRequestId();
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.
Data Type
Integer
ResponseSource Property (Ping Class)
This property includes the source of the last PING response.
Syntax
ANSI (Cross Platform) char* GetResponseSource(); Unicode (Windows) LPWSTR GetResponseSource();
char* ipworks_ping_getresponsesource(void* lpObj);
QString GetResponseSource();
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.
Data Type
String
ResponseStatus Property (Ping Class)
This property includes the status of the last PING response.
Syntax
ANSI (Cross Platform) char* GetResponseStatus(); Unicode (Windows) LPWSTR GetResponseStatus();
char* ipworks_ping_getresponsestatus(void* lpObj);
QString GetResponseStatus();
Default Value
""
Remarks
This property contains the status of the last response. After PingHost has returned, this property will be populated with the status 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.
Data Type
String
ResponseTime Property (Ping Class)
This property includes the time elapsed between sending the original packet and the remote host reply.
Syntax
ANSI (Cross Platform) int GetResponseTime(); Unicode (Windows) INT GetResponseTime();
int ipworks_ping_getresponsetime(void* lpObj);
int GetResponseTime();
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 10 ms and 20 ms).
This property is read-only.
Data Type
Integer
Timeout Property (Ping Class)
This property includes the timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworks_ping_gettimeout(void* lpObj);
int ipworks_ping_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
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 class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
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
TimeToLive Property (Ping Class)
This property includes the time-to-live (TTL) value for the ICMP packets sent by the class.
Syntax
ANSI (Cross Platform) int GetTimeToLive();
int SetTimeToLive(int iTimeToLive); Unicode (Windows) INT GetTimeToLive();
INT SetTimeToLive(INT iTimeToLive);
int ipworks_ping_gettimetolive(void* lpObj);
int ipworks_ping_settimetolive(void* lpObj, int iTimeToLive);
int GetTimeToLive();
int SetTimeToLive(int iTimeToLive);
Default Value
0
Remarks
This method contains the time-to-live (TTL) value for the ICMP packets sent by the class. 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
TypeOfService Property (Ping Class)
This property includes the type of ICMP message sent as a ping request.
Syntax
ANSI (Cross Platform) int GetTypeOfService();
int SetTypeOfService(int iTypeOfService); Unicode (Windows) INT GetTypeOfService();
INT SetTypeOfService(INT iTypeOfService);
int ipworks_ping_gettypeofservice(void* lpObj);
int ipworks_ping_settypeofservice(void* lpObj, int iTypeOfService);
int GetTypeOfService();
int SetTypeOfService(int iTypeOfService);
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.
Data Type
Integer
Activate Method (Ping Class)
This method enables sending and receiving data.
Syntax
ANSI (Cross Platform) int Activate(); Unicode (Windows) INT Activate();
int ipworks_ping_activate(void* lpObj);
int Activate();
Remarks
This method enables sending and receiving of data.
Note: Calling the PingHost method will automatically activate the class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (Ping Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworks_ping_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Deactivate Method (Ping Class)
This method disables sending and receiving data.
Syntax
ANSI (Cross Platform) int Deactivate(); Unicode (Windows) INT Deactivate();
int ipworks_ping_deactivate(void* lpObj);
int Deactivate();
Remarks
This method disables sending and receiving data.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (Ping Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworks_ping_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Interrupt Method (Ping Class)
This method interrupts the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int ipworks_ping_interrupt(void* lpObj);
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PingHost Method (Ping Class)
This method pings a host.
Syntax
ANSI (Cross Platform) int PingHost(const char* lpszHost); Unicode (Windows) INT PingHost(LPCWSTR lpszHost);
int ipworks_ping_pinghost(void* lpObj, const char* lpszHost);
int PingHost(const QString& qsHost);
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.
A PING request (ICMP ECHO) is sent to the Host.
Example. Ping a Host:
PingControl.PingHost("MyHostName")
ResponseTime = PingControl.ResponseTime
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (Ping Class)
This method will reset the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworks_ping_reset(void* lpObj);
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ResolveRemoteHost Method (Ping Class)
This method resolves the hostname in RemoteHost to an IP address.
Syntax
ANSI (Cross Platform) int ResolveRemoteHost(); Unicode (Windows) INT ResolveRemoteHost();
int ipworks_ping_resolveremotehost(void* lpObj);
int 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 class will resolve the hostname automatically when needed. If DelayHostResolution is true, this method may be called to manually resolve RemoteHost, if desired.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WakeOnLAN Method (Ping Class)
This method sends a Wake-On-LAN packet.
Syntax
ANSI (Cross Platform) int WakeOnLAN(const char* lpszRemoteHost, const char* lpszMACAddress); Unicode (Windows) INT WakeOnLAN(LPCWSTR lpszRemoteHost, LPCWSTR lpszMACAddress);
int ipworks_ping_wakeonlan(void* lpObj, const char* lpszRemoteHost, const char* lpszMACAddress);
int WakeOnLAN(const QString& qsRemoteHost, const QString& qsMACAddress);
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 Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (Ping Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(PingErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } PingErrorEventParams;
Unicode (Windows) virtual INT FireError(PingErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } PingErrorEventParams;
#define EID_PING_ERROR 1 virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class PingErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(PingErrorEventParams *e);
// Or, subclass Ping and override this emitter function. virtual int FireError(PingErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Response Event (Ping Class)
This event is fired when a response packet is received.
Syntax
ANSI (Cross Platform) virtual int FireResponse(PingResponseEventParams *e);
typedef struct {
int RequestId;
const char *ResponseSource;
const char *ResponseStatus;
int ResponseTime; int reserved; } PingResponseEventParams;
Unicode (Windows) virtual INT FireResponse(PingResponseEventParams *e);
typedef struct {
INT RequestId;
LPCWSTR ResponseSource;
LPCWSTR ResponseStatus;
INT ResponseTime; INT reserved; } PingResponseEventParams;
#define EID_PING_RESPONSE 2 virtual INT IPWORKS_CALL FireResponse(INT &iRequestId, LPSTR &lpszResponseSource, LPSTR &lpszResponseStatus, INT &iResponseTime);
class PingResponseEventParams { public: int RequestId(); const QString &ResponseSource(); const QString &ResponseStatus(); int ResponseTime(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Response(PingResponseEventParams *e);
// Or, subclass Ping and override this emitter function. virtual int FireResponse(PingResponseEventParams *e) {...}
Remarks
The RequestId parameter is used along 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 or Host unreachable.
Config Settings (Ping 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.Ping 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 (Ping Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Ping Errors
102 | The RemoteHost address is invalid (0.0.0.0). |
127 | The destination is unreachable. |
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). |