EzTrack Control
Properties Methods Events Config Settings Errors
Retrieves tracking data for any package shipped from origin to delivery.
Syntax
EzTrack
Remarks
The EzTrack control provides a standardized interface to all 3 supported carriers. This allows you to reduce the code needed to create an application supporting multiple carriers. For more fine grained control over settings specific to individual carriers you may wish to use the control that is specific to the carrier.
For a given tracking or reference number, this tool identifies the package(s) and provides detailed information about each package, including the current shipping status and the time and location of each scan while in transit. The EzTrack control supports tracking by tracking number, shipment identification number, or reference number. Using this control, you can find out up-to-the-minute specific details on shipping status, including the time and location of each scan as the package moves toward its final destination. And, this tracking information can be displayed in a customized format.
FedEx and UPS both support multiple package shipment tracking, but USPS does not.
When the TrackShipment method call of this control returns a response, it will either return a successful response document or an error document. An error may be returned at the top (response) level if there is a problem with the syntax of the request, or if a system error occurs.
In any of the above scenarios, if there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific identifier.
For more details on errors codes and descriptions, please refer to the Error Codes section.
To use this control, you must set the appropriate Account settings for the specified Provider.
Canada Post Setup and Required Properties
When retrieving tracking information via Canada Post, the following fields are required:
| UserId | The login username for your Canada Post account. |
| Password | The login password for you Canada Post account. |
After a successful TrackShipment call, the following fields will be populated:
| TrackEventDate | Date of a tracking event (yyyy-mm-dd). |
| TrackEventTime | Time of a tracking event (hh:mm:ss). |
| TrackEventStatus | A brief description of the event. |
| TrackEventCity | Site information provided by the parcel handler. |
| TrackEventState | For domestic events, this contains the province that the event occurred in. |
The Canada Post URLS are:
| Test (Development) | https://ct.soa-gw.canadapost.ca |
| Production | https://soa-gw.canadapost.ca |
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| AccountNumber | The shipper's account number. |
| AuthorizationToken | Authorization Token used to authenticate the request. |
| Password | Password for logging in to the Server . |
| Server | URL for the server where the requests are sent. |
| UserId | User Id for logging in to the Server . |
| FirewallAutoDetect | This property tells the control whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| IdentifierType | Type of shipment identifier by which the shipment is to be tracked. |
| PackageCount | The number of packages returned for a given tracking number or any other shipment identifier. |
| PackageIndex | The package index in a shipment being tracked. |
| PackageReceivedBy | The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex . |
| PackageReferences | References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer. |
| PackageSignedBy | Signature of person who signed for package at PackageIndex . |
| PackageTrackingNumber | Package's tracking number corresponding to the PackageIndex . |
| PackageWeight | Weight of the package at PackageIndex . |
| Provider | Which provider to use. |
| ProxyAuthScheme | This property is used to tell the control which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the control whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| ProxyUser | This property contains a username if authentication is to be used for the proxy. |
| RecipientAddress1 | Street name. |
| RecipientAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| RecipientCity | Name of city, town, etc. |
| RecipientCountryCode | Country code. |
| RecipientState | State or province code. |
| RecipientZipCode | Postal code. |
| SenderAddress1 | Street name. |
| SenderAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| SenderCity | Name of city, town, etc. |
| SenderCountryCode | Country code. |
| SenderState | State or province code. |
| SenderZipCode | Postal code. |
| ShipDate | The date on which the package was tendered. |
| ShipDateEnd | End of ship date range used to narrow search. |
| ShipDateStart | Start of ship date range used to narrow search. |
| ShipperAccountNumber | Account number associated with shipment. |
| SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
| SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
| SSLCertStore | This is the name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSLCertStoreType | This is the type of certificate store for this certificate. |
| SSLCertSubject | This is the subject of the certificate used for client authentication. |
| SSLProvider | This specifies the SSL/TLS implementation to use. |
| SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
| Timeout | A timeout for the control. |
| TotalWeight | Total shipment weight. |
| TrackEventCount | The number of records in the TrackEvent arrays. |
| TrackEventAddress1 | Line 1 in the location address where a tracking event occurred (by package). |
| TrackEventAddress2 | Line 2 in the location address where a tracking event occurred (by package). |
| TrackEventCity | Name of the city where the tracking event occurred. |
| TrackEventCompany | Company name if delivered to a company for a given TrackingNumber . |
| TrackEventCountryCode | Country code where the tracking event happened. |
| TrackEventDate | Date the tracking event happened. |
| TrackEventException | The most recent status exception for the tracking event. |
| TrackEventLocation | Location description where a tracking event occurred. |
| TrackEventOther | Other information about the tracking event. |
| TrackEventState | State or province code where the tracking event occurred. |
| TrackEventStatus | Literal description of the tracking event. |
| TrackEventTime | Time the tracking event occurred. |
| TrackEventZipCode | Postal code where the tracking event happened. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Reset | Resets the internal state of the control and all properties to their default values. |
| TrackShipment | Returns tracking data for requested idValue of IdentifierType type. |
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.
| Error | Information about errors during data delivery. |
| Notification | Notification returned by the server upon successful request (if applicable). |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| EndiciaTestMode | Controls whether requests are test requests or live requests. |
| HasXPath | Determines whether a specific element exists in the document. |
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| XAttrCount | The number of records in the XAttr arrays. |
| XAttrName[i] | The name of the indexed attribute. |
| XAttrValue[i] | The value of the indexed attribute. |
| XChildCount | The number of records in the XChild arrays. |
| XChildElement[i] | The name of the indexed child element. |
| XChildText[i] | The text of the indexed child element. |
| XElement | The name of the current element. |
| XParent | The parent of the current element. |
| XPath | Used to set the XPath within the response from the server. |
| XText | The text of the current element. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to True the URL will be encoded by the control. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to True the control will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the control. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusCode | The status code of the last response from the server. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the control. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the control binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| 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. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccountNumber Property (EzTrack Control)
The shipper's account number.
Syntax
eztrackcontrol.AccountNumber[=string]
Default Value
""
Remarks
The shipper's account number.
See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.
For Canada Post, this field should be set to the customer number of the owner of the mail (mailed on behalf of customer).
Data Type
String
AuthorizationToken Property (EzTrack Control)
Authorization Token used to authenticate the request.
Syntax
eztrackcontrol.AuthorizationToken[=string]
Default Value
""
Remarks
Authorization Token used to authenticate the request.
This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.
Data Type
String
Password Property (EzTrack Control)
Password for logging in to the Server .
Syntax
eztrackcontrol.Password[=string]
Default Value
""
Remarks
Password for logging in to the Server.
See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.
For Canada Post, this field should be set to the login password for your Canada Post account.
Data Type
String
Server Property (EzTrack Control)
URL for the server where the requests are sent.
Syntax
eztrackcontrol.Server[=string]
Default Value
""
Remarks
URL for the server where the requests are sent.
See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.
Data Type
String
UserId Property (EzTrack Control)
User Id for logging in to the Server .
Syntax
eztrackcontrol.UserId[=string]
Default Value
""
Remarks
User Id for logging in to the Server.
This property is not used by FedEx.
For Canada Post, this field should be set to the login username for your Canada Post account
Data Type
String
FirewallAutoDetect Property (EzTrack Control)
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Syntax
eztrackcontrol.FirewallAutoDetect[=boolean]
Default Value
False
Remarks
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (EzTrack Control)
This property determines the type of firewall to connect through.
Syntax
eztrackcontrol.FirewallType[=integer]
Possible Values
fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Data Type
Integer
FirewallHost Property (EzTrack Control)
This property contains the name or IP address of firewall (optional).
Syntax
eztrackcontrol.FirewallHost[=string]
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.
Data Type
String
FirewallPassword Property (EzTrack Control)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
eztrackcontrol.FirewallPassword[=string]
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
Data Type
String
FirewallPort Property (EzTrack Control)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
eztrackcontrol.FirewallPort[=integer]
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (EzTrack Control)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
eztrackcontrol.FirewallUser[=string]
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this property and Password properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.
Data Type
String
IdentifierType Property (EzTrack Control)
Type of shipment identifier by which the shipment is to be tracked.
Syntax
eztrackcontrol.IdentifierType[=integer]
Possible Values
itFedExTrackingNumberOrDoorTag(0), itFedExBillOfLading(1), itFedExCODReturnTrackingNumber(2), itFedExCustomerAuthorizationNumber(3), itFedExCustomerReference(4), itFedExDepartment(5), itFedExFreeFormReference(6), itFedExGroundShipmentId(7), itFedExGroundMPS(8), itFedExInvoiceNumber(9), itFedExPartnerCarrierNumber(10), itFedExPartNumber(11), itFedExPONumber(12), itFedExRMANumber(13), itFedExTrackingControlNumber(14), itFedExShipperReference(15), itFedExStandardMPS(16)
Default Value
0
Remarks
This is required if the track request will be made for an identifier other than Tracking Number.
This property is not applicable to UPS or USPS.
Data Type
Integer
PackageCount Property (EzTrack Control)
The number of packages returned for a given tracking number or any other shipment identifier.
Syntax
eztrackcontrol.PackageCount
Default Value
0
Remarks
This property contains the number of packages returned from the Server after calling the TrackShipment method.
Currently, USPS does not support multiple package shipments and this does not apply.
This property is read-only.
Data Type
Integer
PackageIndex Property (EzTrack Control)
The package index in a shipment being tracked.
Syntax
eztrackcontrol.PackageIndex[=integer]
Default Value
0
Remarks
This property contains the index of a package contained in the shipment.
The PackageCount will contain the number of packages included in a shipment and the PackageIndex will contain the package index in the list of packages.
To retrieve all attributes corresponding to a package, the PackageIndex should be set from 0 to PackageCount - 1.
Currently, USPS does not support multiple package shipments and this does not apply.
Data Type
Integer
PackageReceivedBy Property (EzTrack Control)
The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex .
Syntax
eztrackcontrol.PackageReceivedBy
Default Value
""
Remarks
This corresponds to the package at PackageIndex and is returned only if this package has already been delivered.
Note: This property is only used when the Provider is set to pFedEx or pUPS.
This property is read-only.
Data Type
String
PackageReferences Property (EzTrack Control)
References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.
Syntax
eztrackcontrol.PackageReferences
Default Value
""
Remarks
This should be inspected after a call to the TrackShipment method.
For FedEx and UPS, when populated, it should be a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).
A package can have 0 to many reference numbers assigned to it by the shipper when the shipping label was generated.
Currently, USPS does not support multiple package shipments and this does not apply.
This property is read-only.
Data Type
String
PackageSignedBy Property (EzTrack Control)
Signature of person who signed for package at PackageIndex .
Syntax
eztrackcontrol.PackageSignedBy
Default Value
""
Remarks
This corresponds to the package at PackageIndex and is returned only if this package has already been delivered.
Since USPS does not currently support multiple packages, PackageIndex can be ignored, this property returns the name of the person who signed for the package.
This property is read-only.
Data Type
String
PackageTrackingNumber Property (EzTrack Control)
Package's tracking number corresponding to the PackageIndex .
Syntax
eztrackcontrol.PackageTrackingNumber
Default Value
""
Remarks
This is returned in the server's response when the TrackShipment method is called.
Currently, USPS does not support multiple package shipments and this does not apply.
This property is read-only.
Data Type
String
PackageWeight Property (EzTrack Control)
Weight of the package at PackageIndex .
Syntax
eztrackcontrol.PackageWeight
Default Value
""
Remarks
This corresponds to the package at PackageIndex position in the list of packages contained in the shipment.
Currently, USPS does not support multiple package shipments and this does not apply.
This property is read-only.
Data Type
String
Provider Property (EzTrack Control)
Which provider to use.
Syntax
eztrackcontrol.Provider[=integer]
Possible Values
pFedEx(0), pUPS(1), pUSPS(2), pCanadaPost(3)
Default Value
0
Remarks
The "Ez" controls support FedEx, UPS, USPS, and Canada Post servers. This property tells the control which protocol to use.
NOTE: When this property is set, all properties of the control will be reset to their default values.
Data Type
Integer
ProxyAuthScheme Property (EzTrack Control)
This property is used to tell the control which type of authorization to perform when connecting to the proxy.
Syntax
eztrackcontrol.ProxyAuthScheme[=integer]
Possible Values
authBasic(0), authDigest(1), authProprietary(2), authNone(3), authNtlm(4), authNegotiate(5)
Default Value
0
Remarks
This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the User and Password properties are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of User and Password.
Data Type
Integer
ProxyAutoDetect Property (EzTrack Control)
This property tells the control whether or not to automatically detect and use proxy system settings, if available.
Syntax
eztrackcontrol.ProxyAutoDetect[=boolean]
Default Value
False
Remarks
This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .
Data Type
Boolean
ProxyPassword Property (EzTrack Control)
This property contains a password if authentication is to be used for the proxy.
Syntax
eztrackcontrol.ProxyPassword[=string]
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (EzTrack Control)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
eztrackcontrol.ProxyPort[=integer]
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server property for details.
Data Type
Integer
ProxyServer Property (EzTrack Control)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
eztrackcontrol.ProxyServer[=string]
Default Value
""
Remarks
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (EzTrack Control)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
eztrackcontrol.ProxySSL[=integer]
Possible Values
psAutomatic(0), psAlways(1), psNever(2), psTunnel(3)
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
| psAutomatic (0) | Default setting. If the URL is an https URL, the control will use the psTunnel option. If the URL is an http URL, the control will use the psNever option. |
| psAlways (1) | The connection is always SSL enabled. |
| psNever (2) | The connection is not SSL enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (EzTrack Control)
This property contains a username if authentication is to be used for the proxy.
Syntax
eztrackcontrol.ProxyUser[=string]
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Data Type
String
RecipientAddress1 Property (EzTrack Control)
Street name.
Syntax
eztrackcontrol.RecipientAddress1[=string]
Default Value
""
Remarks
Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.
Data Type
String
RecipientAddress2 Property (EzTrack Control)
A specific detail on the address (such as building, suite, apartment, floor number etc.
Syntax
eztrackcontrol.RecipientAddress2[=string]
Default Value
""
Remarks
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.
Data Type
String
RecipientCity Property (EzTrack Control)
Name of city, town, etc.
Syntax
eztrackcontrol.RecipientCity[=string]
Default Value
""
Remarks
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.
Data Type
String
RecipientCountryCode Property (EzTrack Control)
Country code.
Syntax
eztrackcontrol.RecipientCountryCode[=string]
Default Value
"US"
Remarks
Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.
Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.
| Country Name | Country Code |
| Afghanistan | AF |
| Albania | AL |
| American Samoa | AS |
| Andorra | AD |
| Angola | AO |
| Anguilla | AI |
| Antigua | AG* |
| Argentina | AR |
| Armenia | AM |
| Aruba | AW |
| Australia | AU |
| Austria | AT |
| Azerbaijan | AZ |
| Bahamas | BS |
| Bahrain | BH |
| Bangladesh | BD |
| Barbados | BB |
| Barbuda | AG* |
| Belarus | BY |
| Belgium | BE |
| Belize | BZ |
| Benin | BJ |
| Bermuda | BM |
| Bhutan | BT |
| Bolivia | BO |
| Bonaire | AN** |
| Bosnia-Herzegovina | BA |
| Botswana | BW |
| Brazil | BR |
| British Virgin Islands | VG* |
| Brunei | BN |
| Bulgaria | BG |
| Burkina Faso | BF |
| Burundi | BI |
| Cambodia | KH |
| Cameroon | CM |
| Canada | CA |
| Canary Islands | ES** |
| Cape Verde | CV |
| Cayman Islands | KY** |
| Chad | TD |
| Channel Islands | GB** |
| Chile | CL |
| China | CN |
| Colombia | CO |
| Congo | CG |
| Congo Dem. Rep. Of | CD |
| Cook Islands | CK |
| Costa Rica | CR |
| Croatia | HR |
| Curacao | AN** |
| Cyprus | CY |
| Czech Republic | CZ |
| Denmark | DK |
| Djibouti | DJ |
| Dominica | DM |
| Dominican Republic | DO |
| East Timor | TL |
| Ecuador | EC |
| Egypt | EG |
| El Salvador | SV |
| England | GB** |
| Equatorial Guinea | GQ |
| Eritrea | ER |
| Estonia | EE |
| Ethiopia | ET |
| Faeroe Islands | FO* |
| Fiji | FJ |
| Finland | FI |
| France | FR |
| French Guiana | GF |
| French Polynesia | PF** |
| Gabon | GA |
| Gambia | GM |
| Georgia | GE |
| Germany | DE |
| Ghana | GH |
| Gibraltar | GI |
| Grand Cayman | KY** |
| Great Britain | GB** |
| Great Thatch Island | VG* |
| Great Tobago Islands | VG* |
| Greece | GR |
| Greenland | GL |
| Grenada | GD |
| Guadeloupe | GP** |
| Guam | GU |
| Guatemala | GT |
| Guinea | GN |
| Guyana | GY |
| Haiti | HT |
| Holland | NL** |
| Honduras | HN |
| Hong Kong | HK |
| Hungary | HU |
| Iceland | IS |
| India | IN |
| Indonesia | ID |
| Iraq | IQ |
| Ireland | IE |
| Israel | IL |
| Italy | IT** |
| Ivory Coast | CI |
| Jamaica | JM |
| Japan | JP |
| Jordan | JO |
| Jost Van Dyke Islands | VG* |
| Kazakhstan | KZ |
| Kenya | KE |
| Kuwait | KW |
| Kyrgyzstan | KG |
| Laos | LA |
| Latvia | LV |
| Lebanon | LB |
| Lesotho | LS |
| Liberia | LR |
| Liechtenstein | LI |
| Lithuania | LT |
| Luxembourg | LU |
| Macau | MO |
| Macedonia | MK |
| Madagascar | MG |
| Malawi | MW |
| Malaysia | MY |
| Maldives | MV |
| Mali | ML |
| Malta | MT |
| Marshall Islands | MH |
| Martinique | MQ |
| Mauritania | MR |
| Mauritius | MU |
| Mexico | MX |
| Micronesia | FM |
| Moldova | MD |
| Monaco | MC |
| Mongolia | MN |
| Montserrat | MS |
| Morocco | MA |
| Mozambique | MZ |
| Namibia | NA |
| Nepal | NP |
| Netherlands | NL** |
| Netherlands Antilles | AN** |
| New Caledonia | NC |
| New Zealand | NZ |
| Nicaragua | NI |
| Niger | NE |
| Nigeria | NG |
| Norman Island | VG* |
| Northern Ireland | GB** |
| Northern Mariana Islands | MP** |
| Norway | NO |
| Oman | OM |
| Pakistan | PK |
| Palau | PW |
| Palestine | PS* |
| Panama | PA |
| Papua New Guinea | PG |
| Paraguay | PY |
| Peru | PE |
| Philippines | PH |
| Poland | PL |
| Portugal | PT |
| Puerto Rico | PR |
| Qatar | QA |
| Reunion | RE |
| Romania | RO |
| Rota | MP** |
| Russia | RU |
| Rwanda | RW |
| Saba | AN** |
| Saipan | MP** |
| Samoa | WS |
| San Marino | IT** |
| Saudi Arabia | SA |
| Scotland | GB** |
| Senegal | SN |
| Serbia & Montenegro | CS |
| Seychelles | SC |
| Singapore | SG |
| Slovak Republic | SK |
| Slovenia | SI |
| South Africa | ZA |
| South Korea | KR |
| Spain | ES** |
| Sri Lanka | LK |
| St. Barthelemy | GP** |
| St. Christopher | KN** |
| St. Croix Island | VI** |
| St. Eustatius | AN** |
| St. John | VI** |
| St. Kitts and Nevis | KN** |
| St. Lucia | LC |
| St. Maarten | AN** |
| St. Thomas | VI** |
| St. Vincent | VC** |
| Suriname | SR |
| Swaziland | SZ |
| Sweden | SE |
| Switzerland | CH |
| Tahiti | PF** |
| Taiwan | TW |
| Tanzania | TZ |
| Thailand | TH |
| Tinian | MP** |
| Togo | TG |
| Tonga | TO |
| Tortola Island | VG* |
| Trinidad & Tobago | TT |
| Tunisia | TN |
| Turkey | TR |
| Turkmenistan | TM |
| Turks & Caicos Islands | TC |
| U.S. Virgin Islands | VI** |
| Uganda | UG |
| Ukraine | UA |
| Union Island | VC** |
| United Arab Emirates | AE |
| United Kingdom | GB** |
| United States | US |
| Uruguay | UY |
| Uzbekistan | UZ |
| Vanuatu | VU |
| Vatican City | IT** |
| Venezuela | VE |
| Vietnam | VN |
| Wales | GB** |
| Wallis & Futuna Islands | WF |
| Yemen | YE |
| Zambia | ZM |
| Zimbabwe | ZW |
* Not supported by USPS
** Has multiple values, the values used for USPS are below
| Country Name | Country Code |
| Cayman Islands | KY |
| French Polynesia | PF |
| Guadeloupe | GP |
| Italy | IT |
| Netherlands | NL |
| Netherlands Antilles | AN |
| Northern Mariana Islands | MP |
| Spain | ES |
| St. Kitts and Nevis | KN |
| St. Vincent | VC |
| United Kingdom | GB |
| U.S. Virgin Islands | VI |
Data Type
String
RecipientState Property (EzTrack Control)
State or province code.
Syntax
eztrackcontrol.RecipientState[=string]
Default Value
""
Remarks
State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.
Data Type
String
RecipientZipCode Property (EzTrack Control)
Postal code.
Syntax
eztrackcontrol.RecipientZipCode[=string]
Default Value
""
Remarks
Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.
Valid characters: A-Z; 0-9; a-z. Maximum length: 16.
Data Type
String
SenderAddress1 Property (EzTrack Control)
Street name.
Syntax
eztrackcontrol.SenderAddress1
Default Value
""
Remarks
Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS SenderAddress1 should not exceed 35 characters.
This property is read-only.
Data Type
String
SenderAddress2 Property (EzTrack Control)
A specific detail on the address (such as building, suite, apartment, floor number etc.
Syntax
eztrackcontrol.SenderAddress2
Default Value
""
Remarks
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS SenderAddress2 should not exceed 35 characters.
This property is read-only.
Data Type
String
SenderCity Property (EzTrack Control)
Name of city, town, etc.
Syntax
eztrackcontrol.SenderCity
Default Value
""
Remarks
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.
This property is read-only.
Data Type
String
SenderCountryCode Property (EzTrack Control)
Country code.
Syntax
eztrackcontrol.SenderCountryCode
Default Value
"US"
Remarks
Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.
Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.
| Country Name | Country Code |
| Afghanistan | AF |
| Albania | AL |
| American Samoa | AS |
| Andorra | AD |
| Angola | AO |
| Anguilla | AI |
| Antigua | AG* |
| Argentina | AR |
| Armenia | AM |
| Aruba | AW |
| Australia | AU |
| Austria | AT |
| Azerbaijan | AZ |
| Bahamas | BS |
| Bahrain | BH |
| Bangladesh | BD |
| Barbados | BB |
| Barbuda | AG* |
| Belarus | BY |
| Belgium | BE |
| Belize | BZ |
| Benin | BJ |
| Bermuda | BM |
| Bhutan | BT |
| Bolivia | BO |
| Bonaire | AN** |
| Bosnia-Herzegovina | BA |
| Botswana | BW |
| Brazil | BR |
| British Virgin Islands | VG* |
| Brunei | BN |
| Bulgaria | BG |
| Burkina Faso | BF |
| Burundi | BI |
| Cambodia | KH |
| Cameroon | CM |
| Canada | CA |
| Canary Islands | ES** |
| Cape Verde | CV |
| Cayman Islands | KY** |
| Chad | TD |
| Channel Islands | GB** |
| Chile | CL |
| China | CN |
| Colombia | CO |
| Congo | CG |
| Congo Dem. Rep. Of | CD |
| Cook Islands | CK |
| Costa Rica | CR |
| Croatia | HR |
| Curacao | AN** |
| Cyprus | CY |
| Czech Republic | CZ |
| Denmark | DK |
| Djibouti | DJ |
| Dominica | DM |
| Dominican Republic | DO |
| East Timor | TL |
| Ecuador | EC |
| Egypt | EG |
| El Salvador | SV |
| England | GB** |
| Equatorial Guinea | GQ |
| Eritrea | ER |
| Estonia | EE |
| Ethiopia | ET |
| Faeroe Islands | FO* |
| Fiji | FJ |
| Finland | FI |
| France | FR |
| French Guiana | GF |
| French Polynesia | PF** |
| Gabon | GA |
| Gambia | GM |
| Georgia | GE |
| Germany | DE |
| Ghana | GH |
| Gibraltar | GI |
| Grand Cayman | KY** |
| Great Britain | GB** |
| Great Thatch Island | VG* |
| Great Tobago Islands | VG* |
| Greece | GR |
| Greenland | GL |
| Grenada | GD |
| Guadeloupe | GP** |
| Guam | GU |
| Guatemala | GT |
| Guinea | GN |
| Guyana | GY |
| Haiti | HT |
| Holland | NL** |
| Honduras | HN |
| Hong Kong | HK |
| Hungary | HU |
| Iceland | IS |
| India | IN |
| Indonesia | ID |
| Iraq | IQ |
| Ireland | IE |
| Israel | IL |
| Italy | IT** |
| Ivory Coast | CI |
| Jamaica | JM |
| Japan | JP |
| Jordan | JO |
| Jost Van Dyke Islands | VG* |
| Kazakhstan | KZ |
| Kenya | KE |
| Kuwait | KW |
| Kyrgyzstan | KG |
| Laos | LA |
| Latvia | LV |
| Lebanon | LB |
| Lesotho | LS |
| Liberia | LR |
| Liechtenstein | LI |
| Lithuania | LT |
| Luxembourg | LU |
| Macau | MO |
| Macedonia | MK |
| Madagascar | MG |
| Malawi | MW |
| Malaysia | MY |
| Maldives | MV |
| Mali | ML |
| Malta | MT |
| Marshall Islands | MH |
| Martinique | MQ |
| Mauritania | MR |
| Mauritius | MU |
| Mexico | MX |
| Micronesia | FM |
| Moldova | MD |
| Monaco | MC |
| Mongolia | MN |
| Montserrat | MS |
| Morocco | MA |
| Mozambique | MZ |
| Namibia | NA |
| Nepal | NP |
| Netherlands | NL** |
| Netherlands Antilles | AN** |
| New Caledonia | NC |
| New Zealand | NZ |
| Nicaragua | NI |
| Niger | NE |
| Nigeria | NG |
| Norman Island | VG* |
| Northern Ireland | GB** |
| Northern Mariana Islands | MP** |
| Norway | NO |
| Oman | OM |
| Pakistan | PK |
| Palau | PW |
| Palestine | PS* |
| Panama | PA |
| Papua New Guinea | PG |
| Paraguay | PY |
| Peru | PE |
| Philippines | PH |
| Poland | PL |
| Portugal | PT |
| Puerto Rico | PR |
| Qatar | QA |
| Reunion | RE |
| Romania | RO |
| Rota | MP** |
| Russia | RU |
| Rwanda | RW |
| Saba | AN** |
| Saipan | MP** |
| Samoa | WS |
| San Marino | IT** |
| Saudi Arabia | SA |
| Scotland | GB** |
| Senegal | SN |
| Serbia & Montenegro | CS |
| Seychelles | SC |
| Singapore | SG |
| Slovak Republic | SK |
| Slovenia | SI |
| South Africa | ZA |
| South Korea | KR |
| Spain | ES** |
| Sri Lanka | LK |
| St. Barthelemy | GP** |
| St. Christopher | KN** |
| St. Croix Island | VI** |
| St. Eustatius | AN** |
| St. John | VI** |
| St. Kitts and Nevis | KN** |
| St. Lucia | LC |
| St. Maarten | AN** |
| St. Thomas | VI** |
| St. Vincent | VC** |
| Suriname | SR |
| Swaziland | SZ |
| Sweden | SE |
| Switzerland | CH |
| Tahiti | PF** |
| Taiwan | TW |
| Tanzania | TZ |
| Thailand | TH |
| Tinian | MP** |
| Togo | TG |
| Tonga | TO |
| Tortola Island | VG* |
| Trinidad & Tobago | TT |
| Tunisia | TN |
| Turkey | TR |
| Turkmenistan | TM |
| Turks & Caicos Islands | TC |
| U.S. Virgin Islands | VI** |
| Uganda | UG |
| Ukraine | UA |
| Union Island | VC** |
| United Arab Emirates | AE |
| United Kingdom | GB** |
| United States | US |
| Uruguay | UY |
| Uzbekistan | UZ |
| Vanuatu | VU |
| Vatican City | IT** |
| Venezuela | VE |
| Vietnam | VN |
| Wales | GB** |
| Wallis & Futuna Islands | WF |
| Yemen | YE |
| Zambia | ZM |
| Zimbabwe | ZW |
* Not supported by USPS
** Has multiple values, the values used for USPS are below
| Country Name | Country Code |
| Cayman Islands | KY |
| French Polynesia | PF |
| Guadeloupe | GP |
| Italy | IT |
| Netherlands | NL |
| Netherlands Antilles | AN |
| Northern Mariana Islands | MP |
| Spain | ES |
| St. Kitts and Nevis | KN |
| St. Vincent | VC |
| United Kingdom | GB |
| U.S. Virgin Islands | VI |
This property is read-only.
Data Type
String
SenderState Property (EzTrack Control)
State or province code.
Syntax
eztrackcontrol.SenderState
Default Value
""
Remarks
State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.
This property is read-only.
Data Type
String
SenderZipCode Property (EzTrack Control)
Postal code.
Syntax
eztrackcontrol.SenderZipCode
Default Value
""
Remarks
Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both SenderCity and SenderState are not present.
Valid characters: A-Z; 0-9; a-z. Maximum length: 16.
This property is read-only.
Data Type
String
ShipDate Property (EzTrack Control)
The date on which the package was tendered.
Syntax
eztrackcontrol.ShipDate
Default Value
""
Remarks
This property is returned when the TrackShipment method is called.
This property is read-only and not available at design time.
Data Type
String
ShipDateEnd Property (EzTrack Control)
End of ship date range used to narrow search.
Syntax
eztrackcontrol.ShipDateEnd[=string]
Default Value
""
Remarks
For FedEx, this property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateStart is required. Format: YYYY-MM-DD.
This property is not applicable to UPS or USPS requests.
Data Type
String
ShipDateStart Property (EzTrack Control)
Start of ship date range used to narrow search.
Syntax
eztrackcontrol.ShipDateStart[=string]
Default Value
""
Remarks
For FedEx, this property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateEnd is required. Format: YYYY-MM-DD.
This property does not apply to UPS or USPS.
Data Type
String
ShipperAccountNumber Property (EzTrack Control)
Account number associated with shipment.
Syntax
eztrackcontrol.ShipperAccountNumber[=string]
Default Value
""
Remarks
This indicates the account number associated with shipment (as opposed to the AccountNumber, which is that of party sending the request).
For FedEx, when providing the ShipperAccountNumber, the server will return all packages matching the search criteria and associated with this account. If account is not specified, then the RecipientCountryCode and RecipientZipCode (applicable countries) are required. The Reply data may be restricted if ShipperAccountNumber is not provided.
For UPS, this can be provided in a track request to narrow down the search results. It can also be returned in the server response when the TrackShipment method is called.
This is not used by the USPS control.
Data Type
String
SSLAcceptServerCertEncoded Property (EzTrack Control)
This is the certificate (PEM/Base64 encoded).
Syntax
eztrackcontrol.SSLAcceptServerCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (EzTrack Control)
This is the certificate (PEM/Base64 encoded).
Syntax
eztrackcontrol.SSLCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (EzTrack Control)
This is the name of the certificate store for the client certificate.
Syntax
eztrackcontrol.SSLCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (EzTrack Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
eztrackcontrol.SSLCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (EzTrack Control)
This is the type of certificate store for this certificate.
Syntax
eztrackcontrol.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (EzTrack Control)
This is the subject of the certificate used for client authentication.
Syntax
eztrackcontrol.SSLCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLProvider Property (EzTrack Control)
This specifies the SSL/TLS implementation to use.
Syntax
eztrackcontrol.SSLProvider[=integer]
Possible Values
sslpAutomatic(0), sslpPlatform(1), sslpInternal(2)
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.
When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.
Data Type
Integer
SSLServerCertEncoded Property (EzTrack Control)
This is the certificate (PEM/Base64 encoded).
Syntax
eztrackcontrol.SSLServerCertEncoded
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (EzTrack Control)
A timeout for the control.
Syntax
eztrackcontrol.Timeout[=integer]
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 control will wait for the operation to complete before returning control.
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.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
TotalWeight Property (EzTrack Control)
Total shipment weight.
Syntax
eztrackcontrol.TotalWeight
Default Value
""
Remarks
This property is returned when the TrackShipment method is called.
This does not apply to USPS.
This property is read-only.
Data Type
String
TrackEventCount Property (EzTrack Control)
The number of records in the TrackEvent arrays.
Syntax
eztrackcontrol.TrackEventCount
Default Value
0
Remarks
This property controls the size of the following arrays:
- TrackEventAddress1
- TrackEventAddress2
- TrackEventCity
- TrackEventCompany
- TrackEventCountryCode
- TrackEventDate
- TrackEventException
- TrackEventLocation
- TrackEventOther
- TrackEventState
- TrackEventStatus
- TrackEventTime
- TrackEventZipCode
This property is read-only and not available at design time.
Data Type
Integer
TrackEventAddress1 Property (EzTrack Control)
Line 1 in the location address where a tracking event occurred (by package).
Syntax
eztrackcontrol.TrackEventAddress1(TrackEventIdx)
Default Value
""
Remarks
Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.
This is not available for USPS tracking requests.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventAddress2 Property (EzTrack Control)
Line 2 in the location address where a tracking event occurred (by package).
Syntax
eztrackcontrol.TrackEventAddress2(TrackEventIdx)
Default Value
""
Remarks
Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.
This is not available for USPS tracking requests.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventCity Property (EzTrack Control)
Name of the city where the tracking event occurred.
Syntax
eztrackcontrol.TrackEventCity(TrackEventIdx)
Default Value
""
Remarks
Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventCompany Property (EzTrack Control)
Company name if delivered to a company for a given TrackingNumber .
Syntax
eztrackcontrol.TrackEventCompany(TrackEventIdx)
Default Value
""
Remarks
Company name if delivered to a company for a given TrackingNumber.
This property is applicable only to USPS and is returned after a call to the TrackShipment method for each tracking event returned by the USPS Server.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventCountryCode Property (EzTrack Control)
Country code where the tracking event happened.
Syntax
eztrackcontrol.TrackEventCountryCode(TrackEventIdx)
Default Value
""
Remarks
Country code where the tracking event happened.
For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventDate Property (EzTrack Control)
Date the tracking event happened.
Syntax
eztrackcontrol.TrackEventDate(TrackEventIdx)
Default Value
""
Remarks
Date the tracking event happened.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventException Property (EzTrack Control)
The most recent status exception for the tracking event.
Syntax
eztrackcontrol.TrackEventException(TrackEventIdx)
Default Value
""
Remarks
The most recent status exception for the tracking event. This is only available for FedEx, and is applicable for Express services only.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventLocation Property (EzTrack Control)
Location description where a tracking event occurred.
Syntax
eztrackcontrol.TrackEventLocation(TrackEventIdx)
Default Value
""
Remarks
Location description where a tracking event occurred.
This is only applicable to UPS.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventOther Property (EzTrack Control)
Other information about the tracking event.
Syntax
eztrackcontrol.TrackEventOther(TrackEventIdx)
Default Value
""
Remarks
Other information about the tracking event.
This is only applicable to USPS and will be populated with any additional information in the tracking event that is not provided by the other properties. Examples of this are "AuthorizedAgent" and "Signer" (when there is a signer for that event).
The format of this property is a comma-separated "name=value" list.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventState Property (EzTrack Control)
State or province code where the tracking event occurred.
Syntax
eztrackcontrol.TrackEventState(TrackEventIdx)
Default Value
""
Remarks
State or province code where the tracking event occurred. This is a two-letter standard abbreviation.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventStatus Property (EzTrack Control)
Literal description of the tracking event.
Syntax
eztrackcontrol.TrackEventStatus(TrackEventIdx)
Default Value
""
Remarks
Literal description of the tracking event.
For UPS, possible values are:
| In Transit | |
| Delivered | |
| Exception | |
| Pickup | |
| Manifest Pickup |
For USPS, if RequestType is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, TrackEventStatus will contain the entire summary and none of the other properties will be populated. For example, this property might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."
If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the TrackEventStatus property that pertains to the specific TrackingNumber.
When RequestType is set to rtDetail however, this property will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.
When using Endicia as your postage provider, Status will be the only field populated and may contain the status, the timestamp, and the location of the tracking event.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventTime Property (EzTrack Control)
Time the tracking event occurred.
Syntax
eztrackcontrol.TrackEventTime(TrackEventIdx)
Default Value
""
Remarks
Time the tracking event occurred.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventZipCode Property (EzTrack Control)
Postal code where the tracking event happened.
Syntax
eztrackcontrol.TrackEventZipCode(TrackEventIdx)
Default Value
""
Remarks
Postal code where the tracking event happened. Returned if the country, where the scanning activity happened, supports postal-code system.
The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
Config Method (EzTrack Control)
Sets or retrieves a configuration setting.
Syntax
eztrackcontrol.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.
Reset Method (EzTrack Control)
Resets the internal state of the control and all properties to their default values.
Syntax
eztrackcontrol.Reset
Remarks
The Reset method does not have any parameters and does not return any value.
TrackShipment Method (EzTrack Control)
Returns tracking data for requested idValue of IdentifierType type.
Syntax
eztrackcontrol.TrackShipment idValue
Remarks
The idValue parameter identifies the shipment. This identifier can be of IdentifierType type. Some identifiers apply to a single package (such as Package Tracking Number), while others apply to multiple packages or shipments of which they are part of. The idValue must be alphanumeric.
FedEx
FedEx uses shipment identification numbers and types to identify and trace every shipment as it goes through the FedEx system to its destination. You can use this shipment identification number and type to track, locate, and verify arrival of a shipment.
When sending a tracking request to the FedEx Server, there is information that the server requires before it will process the request. The following properties can be sent in the request in order to track by tracking number or by any other identifier:
A successful query returns all of the packages within a shipment. For example, if a shipment contained four packages, the query response would show all four packages.
If FedEx system doesn't locate any data for the requested identifier, the transaction will be considered successful and the Warning will contain the 'No data...' message. The full server reply will be saved to RawResponse.
UPS
If the UPS system does not locate any data for the requested idValue, an error message will be returned. The full server reply will be saved to RawResponse.
Upon successful response, the server will return tracking events for each package included in the shipment, and other values tied to that package. For example, if a shipment contained four packages, the query response would show all four packages.
If there is a problem with a specific idValue within the request, the response will raise an error that pertains to the specific idValue.
USPS
For USPS, the IdentifierType property is not valid. Currently, the only way to track USPS packages is by the tracking number, which should be specified as the idValue parameter.
Error Event (EzTrack Control)
Information about errors during data delivery.
Syntax
Sub eztrackcontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Notification Event (EzTrack Control)
Notification returned by the server upon successful request (if applicable).
Syntax
Sub eztrackcontrol_Notification(Message As String)
Remarks
When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.
Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.
SSLServerAuthentication Event (EzTrack Control)
Fired after the server presents its certificate to the client.
Syntax
Sub eztrackcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (EzTrack Control)
Fired when secure connection progress messages are available.
Syntax
Sub eztrackcontrol_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (EzTrack 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.EzTrack Config Settings
| 0 | Live Requests to Production server (default) |
| 1 | Test Requests to Sandbox server |
| 2 | Test Requests to Production server |
| 'name' | A particular element name |
| name[i] | The i-th subelement of the current element with the given name |
| [i] | The i-th subelement of the current element |
| [last()] | The last subelement of the current element |
| [last()-i] | The subelement located at the last location minus i in the current element |
| name[@attrname="attrvalue"] | The subelement containing a particular value for a given attribute (supports single AND double quotes) |
| .. | The parent of the current element |
- XElement points to the name of the element.
- XText points to the text of the element.
- XParent points to the name of the parent element.
- XChildCount provides the number of child elements.
- XChildElement[i] points to the name of the indexed child element.
- XChildText[i] points to the text of the indexed child element.
- XAttrCount provides the number of attributes for this element.
- XAttrName[i] points to the name of the indexed attribute for XElement.
- XAttrValue[i] points to the value of the indexed attribute for XElement.
HTTP Config Settings
When True, the control adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the control will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the control fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP control can be extended with other security schemes in addition to the authorization schemes already implemented by the control.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the control fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the control fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the control will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the control beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the control will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the control returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
| 0 | IPv4 Only |
| 1 | IPv6 Only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the control will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the control is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the control will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default) |
| TLS1.1 | 768 (Hex 300) (Default) |
| TLS1 | 192 (Hex C0) (Default) |
| SSL3 | 48 (Hex 30) [Platform Only] |
| SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the control when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the control will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the control will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown Certificate Authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown Certificate Authority revocation status. |
| 0x00000800 | Ignore unknown Root revocation status. |
| 0x00008000 | Allow test Root certificate. |
| 0x00004000 | Trust test Root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the control will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the control fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
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.
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
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 |
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.
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 (EzTrack Control)
EzTrack Errors
| 20302 Operation interrupted (or timeout). | |
| 20433 Invalid index. | |
| 20528 Server Error Response. | |
| 20529 Property set with invalid data. |
The control may also return one of the following error codes, which are inherited from other controls.