# SOAP Component

The SOAP Component is a generic SOAP client supporting SOAP 1.1 that is used to communicate with SOAP servers.

## Syntax

```text
nsoftware.IPWorks.SOAP
```

## Remarks

The SOAP Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the [SSLServerAuthentication](#sslserverauthentication-event-soap-component) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-soap-component) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [Config](#config-method-soap-component) method.

The SOAP Component implements a standard SOAP client as specified in the SOAP 1.1 specification.

The component uses HTTP to communicate with SOAP servers and uses an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP [Method](#method-property-soap-component) and [MethodURI](#methoduri-property-soap-component), as well as optional parameters in the [Params](#params-property-soap-component) collection. Then set the target [URL](#url-property-soap-component) and call the [SendRequest](#sendrequest-method-soap-component) method.

The results will be provided through the [ReturnValue](#returnvalue-property-soap-component) property and the [Params](#params-property-soap-component) collection (for output parameters). Additionally, properties such as [XPath](#xpath-property-soap-component), [XElement](#xelement-property-soap-component), and [XText](#xtext-property-soap-component) allow for more granular traversal of the SOAP response.

If the server returns an error, the [FaultCode](#faultcode-property-soap-component), [FaultString](#faultstring-property-soap-component), and [FaultActor](#faultactor-property-soap-component) properties will provide information about the error condition.

The component may also be used in offline mode. This is supported by methods such as [BuildPacket](#buildpacket-method-soap-component) and [EvalPacket](#evalpacket-method-soap-component). The corresponding SOAP packet will be stored in the [SOAPPacket](#soappacket-property-soap-component) property. Offline mode is important in cases in which the underlying SOAP transport is not HTTP but another mechanism (e.g., SMTP and POP for email).

By providing direct access to the SOAP packet in offline mode, the component allows for possible extension and full control over the [SOAPPacket](#soappacket-property-soap-component). The [SendPacket](#sendpacket-method-soap-component) method may then be used to send the custom-created [SOAPPacket](#soappacket-property-soap-component) to the destination [URL](#url-property-soap-component).

## Property List

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

|  |  |
| --- | --- |
| [Accept](#accept-property-soap-component) | This property includes a list of acceptable MIME types for the request. |
| [ActionURI](#actionuri-property-soap-component) | This property includes the value of the SOAP-action header. |
| [Authorization](#authorization-property-soap-component) | This property includes the Authorization string to be sent to the server. |
| [AuthScheme](#authscheme-property-soap-component) | This property specifies the authentication scheme to use when server authentication is required. |
| [Connected](#connected-property-soap-component) | Whether the component is connected. |
| [ContentType](#contenttype-property-soap-component) | This property includes the content type for SOAP request data. |
| [Cookies](#cookies-property-soap-component) | A collection of cookies. |
| [FaultActor](#faultactor-property-soap-component) | This property includes the actor of any faults returned by the SOAP server. |
| [FaultCode](#faultcode-property-soap-component) | This property includes the code of any faults returned by the SOAP server. |
| [FaultString](#faultstring-property-soap-component) | This property includes the textual description of any faults returned by the SOAP server. |
| [Firewall](#firewall-property-soap-component) | A set of properties related to firewall access. |
| [FollowRedirects](#followredirects-property-soap-component) | Determines what happens when the server issues a redirect. |
| [Idle](#idle-property-soap-component) | The current status of the component. |
| [IfModifiedSince](#ifmodifiedsince-property-soap-component) | This property includes a date determining the maximum age of the desired document. |
| [LocalFile](#localfile-property-soap-component) | This property includes the path to a local file for downloading. If the file exists, it is overwritten. |
| [LocalHost](#localhost-property-soap-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [Method](#method-property-soap-component) | This property includes the remote [Method](#method-property-soap-component) . |
| [MethodURI](#methoduri-property-soap-component) | This property includes the URI corresponding to the SOAP [Method](#method-property-soap-component) . |
| [Namespaces](#namespaces-property-soap-component) | This property includes a collection of namespaces in the current stack. |
| [OtherHeaders](#otherheaders-property-soap-component) | Other headers as determined by the user (optional). |
| [Params](#params-property-soap-component) | This property includes a collection of parameters for the SOAP [Method](#method-property-soap-component) . |
| [ParsedHeaders](#parsedheaders-property-soap-component) | This property includes a collection of headers returned from the last request. |
| [Password](#password-property-soap-component) | This property includes a password if authentication is to be used. |
| [Pragma](#pragma-property-soap-component) | This property includes a browser- or server-specific header line (optional). |
| [Proxy](#proxy-property-soap-component) | A set of properties related to proxy access. |
| [Referer](#referer-property-soap-component) | This property includes the referer URL/document (optional). |
| [ReturnValue](#returnvalue-property-soap-component) | This property includes the value returned by the SOAP [Method](#method-property-soap-component) . |
| [SOAPEncoding](#soapencoding-property-soap-component) | This property includes the type of SOAP encoding used for SOAP requests. |
| [SOAPHeader](#soapheader-property-soap-component) | This property includes the contents of the optional SOAP header sent to the server. |
| [SOAPPacket](#soappacket-property-soap-component) | This property includes the full contents of the SOAP packet. |
| [SSLAcceptServerCert](#sslacceptservercert-property-soap-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#sslcert-property-soap-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLProvider](#sslprovider-property-soap-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#sslservercert-property-soap-component) | The server certificate for the last established connection. |
| [StatusLine](#statusline-property-soap-component) | This property is the first line of the last server response. |
| [Timeout](#timeout-property-soap-component) | The timeout for the component. |
| [TransferredData](#transferreddata-property-soap-component) | This property includes the contents of the last response from the server. |
| [TransferredDataLimit](#transferreddatalimit-property-soap-component) | This property specifies the maximum amount of data to be transferred. |
| [TransferredHeaders](#transferredheaders-property-soap-component) | The full set of headers as received from the server. |
| [URL](#url-property-soap-component) | This property specifies the URL to retrieve. |
| [User](#user-property-soap-component) | This property includes a user name if authentication is to be used. |
| [ValueFormat](#valueformat-property-soap-component) | This property includes the format of data returned or set. |
| [XAttributes](#xattributes-property-soap-component) | This property includes a collection of attributes of the current element. |
| [XChildren](#xchildren-property-soap-component) | This property includes the collection of child elements for the current element. |
| [XElement](#xelement-property-soap-component) | This property includes the name of the element pointed to by [XPath](#xpath-property-soap-component) . |
| [XNamespace](#xnamespace-property-soap-component) | This property includes the namespace of the element pointed to by [XPath](#xpath-property-soap-component) . |
| [XParent](#xparent-property-soap-component) | This property includes the parent of the element pointed to by [XPath](#xpath-property-soap-component) . |
| [XPath](#xpath-property-soap-component) | This property includes a path into the [SOAPPacket](#soappacket-property-soap-component) received by the server. |
| [XPrefix](#xprefix-property-soap-component) | This property includes the prefix of the element pointed to by [XPath](#xpath-property-soap-component) . |
| [XText](#xtext-property-soap-component) | This property includes the text of the element pointed to by [XPath](#xpath-property-soap-component) . |

## Method List

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

|  |  |
| --- | --- |
| [AddCookie](#addcookie-method-soap-component) | Adds a cookie and the corresponding value to the outgoing request headers. |
| [AddNamespace](#addnamespace-method-soap-component) | This method adds a namespace to the [Namespaces](#namespaces-property-soap-component) properties. |
| [AddParam](#addparam-method-soap-component) | This method adds a parameter-value pair. |
| [Attr](#attr-method-soap-component) | This method returns the value of the specified attribute. |
| [BuildPacket](#buildpacket-method-soap-component) | This method builds the request packet. |
| [Config](#config-method-soap-component) | Sets or retrieves a configuration setting. |
| [DoEvents](#doevents-method-soap-component) | This method processes events from the internal message queue. |
| [EvalPacket](#evalpacket-method-soap-component) | This method evaluates the packet in [SOAPPacket](#soappacket-property-soap-component) . |
| [HasXPath](#hasxpath-method-soap-component) | This method determines whether a specific element exists in the document. |
| [Interrupt](#interrupt-method-soap-component) | This method interrupts the current method. |
| [Reset](#reset-method-soap-component) | This method resets the component. |
| [SendPacket](#sendpacket-method-soap-component) | This method sends the packet. |
| [SendRequest](#sendrequest-method-soap-component) | This method sends the request. |
| [TryXPath](#tryxpath-method-soap-component) | This method navigates to the specified XPath if it exists. |
| [Value](#value-method-soap-component) | This method returns the value of a parameter. |

## Event List

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

|  |  |
| --- | --- |
| [Connected](#connected-event-soap-component) | Fired immediately after a connection completes (or fails). |
| [ConnectionStatus](#connectionstatus-event-soap-component) | Fired to indicate changes in the connection state. |
| [Disconnected](#disconnected-event-soap-component) | Fired when a connection is closed. |
| [EndTransfer](#endtransfer-event-soap-component) | This event is fired when a document finishes transferring. |
| [Error](#error-event-soap-component) | Fired when information is available about errors during data delivery. |
| [Header](#header-event-soap-component) | Fired every time a header line comes in. |
| [Log](#log-event-soap-component) | Fired once for each log message. |
| [Redirect](#redirect-event-soap-component) | Fired when a redirection is received from the server. |
| [SetCookie](#setcookie-event-soap-component) | Fired for every cookie set by the server. |
| [SSLServerAuthentication](#sslserverauthentication-event-soap-component) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-soap-component) | Fired when secure connection progress messages are available. |
| [StartTransfer](#starttransfer-event-soap-component) | This event is fired when a document starts transferring (after the headers). |
| [Status](#status-event-soap-component) | Fired when the HTTP status line is received from the server. |
| [Transfer](#transfer-event-soap-component) | This event is fired while the response transfers. |

## Config Settings

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

|  |  |
| --- | --- |
| [ActionURISeparator](#ActionURISeparator) | The separator between the namespace and the method name in the SOAP Action URI. |
| [EncodingStyleNamespacePrefix](#EncodingStyleNamespacePrefix) | The prefix to be used for the Encoding namespace. |
| [MethodAttributes](#MethodAttributes) | The attributes to include in the method element. |
| [MethodNamespacePrefix](#MethodNamespacePrefix) | The prefix to be used for the Method namespace. |
| [RequestPacket](#RequestPacket) | The SOAP packet that was sent to the server during the last request. |
| [XSubTree](#XSubTree) | A snapshot of the current element in the document. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [AllowNTLMFallback](#AllowNTLMFallback) | Whether to allow fallback from Negotiate to NTLM when authenticating. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the component. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the component will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the component. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxHeaders](#MaxHeaders) | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| [MaxHTTPCookies](#MaxHTTPCookies) | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the component. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UsePlatformDeflate](#UsePlatformDeflate) | Whether to use the platform implementation to decompress compressed responses. |
| [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallListener](#FirewallListener) | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the component binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [CACertFilePaths](#CACertFilePaths) | The paths to CA certificate files when using Mono on Unix/Linux. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [CacheContent](#CacheContent) | If true, the original XML is saved in a buffer. |
| [Charset](#Charset) | Specifies the charset used when encoding data. |
| [CloseInputStreamAfterProcess](#CloseInputStreamAfterProcess) | Determines whether or not the input stream is closed after processing. |
| [CloseOutputStreamAfterProcess](#CloseOutputStreamAfterProcess) | Determines whether or not the output stream is closed after processing. |
| [EOL](#EOL) | The characters to use for separating lines. |
| [ErrorOnEmptyAttr](#ErrorOnEmptyAttr) | If true, passing an invalid attribute to the GetAttr method will throw an exception. |
| [ExtraNameChars](#ExtraNameChars) | Extra characters for the parser to consider as name characters. |
| [ExtraSpaceChars](#ExtraSpaceChars) | Extra characters for the parser to consider as whitespace. |
| [FlushOnEOL](#FlushOnEOL) | If set, the parser flushes its text buffer after every line of text. |
| [IgnoreBadAttributePrefixes](#IgnoreBadAttributePrefixes) | If true, bad (unknown) attribute prefixes are ignored. |
| [IgnoreBadElementPrefixes](#IgnoreBadElementPrefixes) | If true, bad (unknown) element prefixes are ignored. |
| [IncludeElementPrefix](#IncludeElementPrefix) | Whether to include the prefix in the element name. |
| [IncludeXMLDeclaration](#IncludeXMLDeclaration) | Whether to include the XML declaration when writing XML. |
| [Indent](#Indent) | The characters to use for each indentation level. |
| [Interrupt](#Interrupt) | Whether to stop parsing the current XML document. |
| [Offset](#Offset) | Current offset of the document being parsed. |
| [PreserveAll](#PreserveAll) | Whether to preserve processing instructions and comments. |
| [PreserveWhitespace](#PreserveWhitespace) | If true, leading and trailing whitespace in element text is preserved. |
| [ProcessNamespace](#ProcessNamespace) | Whether the parser will process namespaces. |
| [QuoteChar](#QuoteChar) | Quote character to use for attribute values. |
| [StringProcessingOptions](#StringProcessingOptions) | Defines options to use when processing string values. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Accept Property ([SOAP](#soap-component) Component)

This property includes a list of acceptable MIME types for the request.

## Syntax

```text
public string Accept { get; set; }
```

## Default Value

""

## Remarks

If this property contains a nonempty string, an HTTP *Accept* header is added to the request.

The *Accept* header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

# ActionURI Property ([SOAP](#soap-component) Component)

This property includes the value of the SOAP-action header.

## Syntax

```text
public string ActionURI { get; set; }
```

## Default Value

""

## Remarks

When the [MethodURI](#methoduri-property-soap-component) or [Method](#method-property-soap-component) properties are set, the ActionURI property is automatically updated to [MethodURI](#methoduri-property-soap-component), the ActionURISeparator configuration setting, and [Method](#method-property-soap-component) (default separator: "#").

# Authorization Property ([SOAP](#soap-component) Component)

This property includes the * Authorization * string to be sent to the server.

## Syntax

```text
public string Authorization { get; set; }
```

## Default Value

""

## Remarks

If the Authorization property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The [AuthScheme](#authscheme-property-soap-component) property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [User](#user-property-soap-component) and [Password](#password-property-soap-component) are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

# AuthScheme Property ([SOAP](#soap-component) Component)

This property specifies the authentication scheme to use when server authentication is required.

## Syntax

```text
public SOAPAuthSchemes AuthScheme { get; set; }
enum SOAPAuthSchemes {
  authBasic,
  authDigest,
  authProprietary,
  authNone,
  authNtlm,
  authNegotiate,
  authOAuth
}
```

## Default Value

0

## Remarks

This property will tell the component which type of authorization to perform when the [User](#user-property-soap-component) and [Password](#password-property-soap-component) properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the [User](#user-property-soap-component) and [Password](#password-property-soap-component) properties are set, the component will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the [Authorization](#authorization-property-soap-component) property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the [Authorization](#authorization-property-soap-component) property.

NOTE: If you set the [Authorization](#authorization-property-soap-component) property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the component.

For security, changing the value of this property will cause the component to clear the values of [User](#user-property-soap-component), [Password](#password-property-soap-component), and [Authorization](#Authorization).

# Connected Property ([SOAP](#soap-component) Component)

Whether the component is connected.

## Syntax

```text
public bool Connected { get; }
```

## Default Value

False

## Remarks

This property is used to determine whether or not the component is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

# ContentType Property ([SOAP](#soap-component) Component)

This property includes the content type for SOAP request data.

## Syntax

```text
public string ContentType { get; set; }
```

## Default Value

"text/xml"

## Remarks

The default value for ContentType is "text/xml".

This property is not available at design time.

# Cookies Property ([SOAP](#soap-component) Component)

A collection of cookies.

## Syntax

```text
public HTTPCookieList Cookies { get; }
```

## Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type [HTTPCookie](#httpcookie-type)) to this collection.

To see cookies that are set by the server, use the [SetCookie](#setcookie-event-soap-component) event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

[MaxHTTPCookies](#MaxHTTPCookies) can be used to control the maximum number of cookies saved.

This collection is indexed from *0* to *Count - 1*.

This property is not available at design time.

 Please refer to the [HTTPCookie](#httpcookie-type) type for a complete list of fields.

# FaultActor Property ([SOAP](#soap-component) Component)

This property includes the actor of any faults returned by the SOAP server.

## Syntax

```text
public string FaultActor { get; }
```

## Default Value

""

## Remarks

[FaultCode](#faultcode-property-soap-component) and [FaultString](#faultstring-property-soap-component) provide the corresponding fault code and description.

This property is read-only.

# FaultCode Property ([SOAP](#soap-component) Component)

This property includes the code of any faults returned by the SOAP server.

## Syntax

```text
public string FaultCode { get; }
```

## Default Value

""

## Remarks

[FaultString](#faultstring-property-soap-component) and [FaultActor](#faultactor-property-soap-component) provide the corresponding fault description and actor.

This property is read-only.

# FaultString Property ([SOAP](#soap-component) Component)

This property includes the textual description of any faults returned by the SOAP server.

## Syntax

```text
public string FaultString { get; }
```

## Default Value

""

## Remarks

[FaultCode](#faultcode-property-soap-component) and [FaultActor](#faultactor-property-soap-component) provide the corresponding fault code and actor.

This property is read-only.

# Firewall Property ([SOAP](#soap-component) Component)

A set of properties related to firewall access.

## Syntax

```text
public Firewall Firewall { get; set; }
```

## Remarks

This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect.

 Please refer to the [Firewall](#firewall-type) type for a complete list of fields.

# FollowRedirects Property ([SOAP](#soap-component) Component)

Determines what happens when the server issues a redirect.

## Syntax

```text
public SOAPFollowRedirects FollowRedirects { get; set; }
enum SOAPFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}
```

## Default Value

0

## Remarks

This property determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new [URL](#url-property-soap-component) for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new [URL](#url-property-soap-component) is retrieved automatically only if the URLScheme is the same; otherwise, the component throws an exception.

NOTE: Following the HTTP specification, unless this property is set to frAlways (1), 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](#user-property-soap-component) and [Password](#password-property-soap-component) are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A [Redirect](#redirect-event-soap-component) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-soap-component) event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the component throws an exception instead.

# Idle Property ([SOAP](#soap-component) Component)

The current status of the component.

## Syntax

```text
public bool Idle { get; }
```

## Default Value

True

## Remarks

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

This property is read-only.

# IfModifiedSince Property ([SOAP](#soap-component) Component)

This property includes a date determining the maximum age of the desired document.

## Syntax

```text
public string IfModifiedSince { get; set; }
```

## Default Value

""

## Remarks

If this property contains a nonempty string, an *If-Modified-Since* HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

This property is not available at design time.

# LocalFile Property ([SOAP](#soap-component) Component)

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

## Syntax

```text
public string LocalFile { get; set; }
```

## Default Value

""

## Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through [TransferredData](#transferreddata-property-soap-component) and the [Transfer](#transfer-event-soap-component) event.

# LocalHost Property ([SOAP](#soap-component) Component)

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

## Syntax

```text
public string LocalHost { get; set; }
```

## Default Value

""

## Remarks

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

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

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

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

# Method Property ([SOAP](#soap-component) Component)

This property includes the remote [Method](#method-property-soap-component) .

## Syntax

```text
public string Method { get; set; }
```

## Default Value

""

## Remarks

When the [MethodURI](#methoduri-property-soap-component) or Method properties are set, the [ActionURI](#actionuri-property-soap-component) property is automatically updated to [MethodURI](#methoduri-property-soap-component), the ActionURISeparator configuration setting, and Method (default separator: "#").

# MethodURI Property ([SOAP](#soap-component) Component)

This property includes the URI corresponding to the SOAP [Method](#method-property-soap-component) .

## Syntax

```text
public string MethodURI { get; set; }
```

## Default Value

""

## Remarks

When the MethodURI or [Method](#method-property-soap-component) properties are set, the [ActionURI](#actionuri-property-soap-component) property is automatically updated to MethodURI, the ActionURISeparator configuration setting, and [Method](#method-property-soap-component) (default separator: "#").

# Namespaces Property ([SOAP](#soap-component) Component)

This property includes a collection of namespaces in the current stack.

## Syntax

```text
public XMLNamespaceList Namespaces { get; }
```

## Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

If the SOAP envelope URI is not found in the namespaces collection, it will be added with the prefix *SOAP-ENV* when generating a SOAP request. The SOAP envelope URI is 'http://schemas.xmlsoap.org/soap/envelope/'.

This collection is indexed from *0* to *Count - 1*.

This property is not available at design time.

 Please refer to the [XMLNamespace](#xmlnamespace-type) type for a complete list of fields.

# OtherHeaders Property ([SOAP](#soap-component) Component)

Other headers as determined by the user (optional).

## Syntax

```text
public string OtherHeaders { get; set; }
```

## Default Value

""

## Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like [ContentType](#contenttype-property-soap-component) and From.

The headers must follow the format *Header: Value* as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

# Params Property ([SOAP](#soap-component) Component)

This property includes a collection of parameters for the SOAP [Method](#method-property-soap-component) .

## Syntax

```text
public SOAPParamList Params { get; }
```

## Remarks

When using [SendRequest](#sendrequest-method-soap-component), this property can be populated with the parameters to include in the request to the SOAP [Method](#method-property-soap-component).

When receiving SOAP responses from the server, the component parses the response envelope parameters into the collection.

This collection is indexed from *0* to *Count - 1*.

This property is not available at design time.

 Please refer to the [SOAPParam](#soapparam-type) type for a complete list of fields.

# ParsedHeaders Property ([SOAP](#soap-component) Component)

This property includes a collection of headers returned from the last request.

## Syntax

```text
public HeaderList ParsedHeaders { get; }
```

## Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each [Header](#header-type) in this collection contains information describing that header.

[MaxHeaders](#MaxHeaders) can be used to control the maximum number of headers saved.

This collection is indexed from *0* to *Count - 1*.

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

 Please refer to the [Header](#header-type) type for a complete list of fields.

# Password Property ([SOAP](#soap-component) Component)

This property includes a password if authentication is to be used.

## Syntax

```text
public string Password { get; set; }
```

## Default Value

""

## Remarks

This property contains a password if authentication is to be used. If [AuthScheme](#authscheme-property-soap-component) is set to HTTP Basic Authentication, the [User](#user-property-soap-component) and Password are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]".

If [AuthScheme](#authscheme-property-soap-component) is set to HTTP Digest Authentication, the [User](#user-property-soap-component) and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If [AuthScheme](#authscheme-property-soap-component) is set to NTLM, NTLM authentication will be attempted. If [AuthScheme](#authscheme-property-soap-component) is set to NTLM and [User](#user-property-soap-component) and Password are empty, the component will attempt to authenticate using the current user's credentials.

# Pragma Property ([SOAP](#soap-component) Component)

This property includes a browser- or server-specific header line (optional).

## Syntax

```text
public string Pragma { get; set; }
```

## Default Value

""

## Remarks

If this property contains a nonempty string, a *Pragma* HTTP request header is added to the request. The meaning of the header depends on the implementation. It can be used to send or receive proprietary information to or from the server.

This property is not available at design time.

# Proxy Property ([SOAP](#soap-component) Component)

A set of properties related to proxy access.

## Syntax

```text
public Proxy Proxy { get; set; }
```

## Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

 Please refer to the [Proxy](#proxy-type) type for a complete list of fields.

# Referer Property ([SOAP](#soap-component) Component)

This property includes the referer URL/document (optional).

## Syntax

```text
public string Referer { get; set; }
```

## Default Value

""

## Remarks

If this property contains a nonempty string, a *Referer* HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

# ReturnValue Property ([SOAP](#soap-component) Component)

This property includes the value returned by the SOAP [Method](#method-property-soap-component) .

## Syntax

```text
public string ReturnValue { get; }
```

## Default Value

""

## Remarks

ReturnValue corresponds to the first item in the [Params](#params-property-soap-component) collection.

This property is read-only.

# SOAPEncoding Property ([SOAP](#soap-component) Component)

This property includes the type of SOAP encoding used for SOAP requests.

## Syntax

```text
public string SOAPEncoding { get; set; }
```

## Default Value

"http://schemas.xmlsoap.org/soap/encoding/"

## Remarks

This is the value of the *encodingStyle* attribute of the SOAP envelope.

# SOAPHeader Property ([SOAP](#soap-component) Component)

This property includes the contents of the optional SOAP header sent to the server.

## Syntax

```text
public string SOAPHeader { get; set; }
```

## Default Value

""

## Remarks

This property is used only when building SOAP requests.

This property is not available at design time.

# SOAPPacket Property ([SOAP](#soap-component) Component)

This property includes the full contents of the SOAP packet.

## Syntax

```text
public string SOAPPacket { get; set; }
```

## Default Value

""

## Remarks

The SOAPPacket property contains the contents of the SOAP packet created by the component before submitting a request as well as the full, unmodified contents of the SOAP response as received from the server after the request.

This property is not available at design time.

# SSLAcceptServerCert Property ([SOAP](#soap-component) Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

## Syntax

```text
public Certificate SSLAcceptServerCert { get; set; }
```

## Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLCert Property ([SOAP](#soap-component) Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
public Certificate SSLCert { get; set; }
```

## Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLProvider Property ([SOAP](#soap-component) Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

## Syntax

```text
public SOAPSSLProviders SSLProvider { get; set; }
enum SOAPSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}
```

## 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 component 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 as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

The .NET Standard library will always use the internal implementation on all platforms.

# SSLServerCert Property ([SOAP](#soap-component) Component)

The server certificate for the last established connection.

## Syntax

```text
public Certificate SSLServerCert { get; }
```

## Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# StatusLine Property ([SOAP](#soap-component) Component)

This property is the first line of the last server response.

## Syntax

```text
public string StatusLine { get; }
```

## Default Value

""

## Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the component, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

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

# Timeout Property ([SOAP](#soap-component) Component)

The timeout for the component.

## Syntax

```text
public int Timeout { get; set; }
```

## 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 component will wait for the operation to complete before returning control.

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

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

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

# TransferredData Property ([SOAP](#soap-component) Component)

This property includes the contents of the last response from the server.

## Syntax

```text
public string TransferredData { get; }
public byte[] TransferredDataB { get; }
```

## Default Value

""

## Remarks

This property contains the contents of the last response from the server. If the [LocalFile](#localfile-property-soap-component) is empty, the data are accumulated in TransferredData and also can be received in the [Transfer](#transfer-event-soap-component) event. Otherwise, this property returns an empty string.

[TransferredDataLimit](#transferreddatalimit-property-soap-component) controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

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

# TransferredDataLimit Property ([SOAP](#soap-component) Component)

This property specifies the maximum amount of data to be transferred.

## Syntax

```text
public long TransferredDataLimit { get; set; }
```

## Default Value

0

## Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the [TransferredData](#transferreddata-property-soap-component) property.

# TransferredHeaders Property ([SOAP](#soap-component) Component)

The full set of headers as received from the server.

## Syntax

```text
public string TransferredHeaders { get; }
```

## Default Value

""

## Remarks

This property returns the complete set of raw headers as received from the server.

The [Header](#header-event-soap-component) event shows the individual headers as parsed by the component.

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

# URL Property ([SOAP](#soap-component) Component)

This property specifies the URL to retrieve.

## Syntax

```text
public string URL { get; set; }
```

## Default Value

""

## Remarks

This property contains the URL of the document. This value is parsed, and the results are put in the URLScheme, URLServer, URLPort, and URLPath properties.

# User Property ([SOAP](#soap-component) Component)

This property includes a user name if authentication is to be used.

## Syntax

```text
public string User { get; set; }
```

## Default Value

""

## Remarks

This property contains a user name if authentication is to be used. If [AuthScheme](#authscheme-property-soap-component) is set to HTTP Basic Authentication, The User and [Password](#password-property-soap-component) are Base64 encoded, and the result is put in the [Authorization](#Authorization) property in the form "Basic [encoded-user-password]".

If [AuthScheme](#authscheme-property-soap-component) is set to HTTP Digest Authentication, the User and [Password](#password-property-soap-component) properties are used to respond to the HTTP Digest Authentication challenge from the server.

If [AuthScheme](#authscheme-property-soap-component) is set to NTLM, NTLM authentication will be attempted. If [AuthScheme](#authscheme-property-soap-component) is set to NTLM, and User and [Password](#password-property-soap-component) are empty, the component will attempt to authenticate using the current user's credentials.

# ValueFormat Property ([SOAP](#soap-component) Component)

This property includes the format of data returned or set.

## Syntax

```text
public SOAPValueFormats ValueFormat { get; set; }
enum SOAPValueFormats {
  vfText,
  vfXML,
  vfFullXML
}
```

## Default Value

1

## Remarks

The ValueFormat property specifies the format of the data set or received into/from value properties, such as [XText](#xtext-property-soap-component), [ReturnValue](#returnvalue-property-soap-component), and the [Params](#params-property-soap-component) collection.

The following are the possible values:

|  |  |
| --- | --- |
| vfText (0) | Textual data. Any '<', '>', and '&' characters are escaped to '<', '>', and '&'. |
| vfXML (1) | XML data, not including the enclosing element tags. No escaping is performed for the XML data, but element data (such as element attributes) will be escaped. |
| vfFullXML (2) | Same as vfXML, but including the enclosing element. No escaping is performed for the XML data or for the XML element. |

# XAttributes Property ([SOAP](#soap-component) Component)

This property includes a collection of attributes of the current element.

## Syntax

```text
public XMLAttributeList XAttributes { get; }
```

## Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of [XMLAttribute](#xmlattribute-type) types.

This collection is indexed from *0* to *Count - 1*.

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

 Please refer to the [XMLAttribute](#xmlattribute-type) type for a complete list of fields.

# XChildren Property ([SOAP](#soap-component) Component)

This property includes the collection of child elements for the current element.

## Syntax

```text
public XMLElementList XChildren { get; }
```

## Remarks

These elements are provided in the collection in the same order they are found in the document.

This collection is indexed from *0* to *Count - 1*.

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

 Please refer to the [XMLElement](#xmlelement-type) type for a complete list of fields.

# XElement Property ([SOAP](#soap-component) Component)

This property includes the name of the element pointed to by [XPath](#xpath-property-soap-component) .

## Syntax

```text
public string XElement { get; }
```

## Default Value

""

## Remarks

The corresponding prefix is provided by [XPrefix](#xprefix-property-soap-component).

This property is read-only.

# XNamespace Property ([SOAP](#soap-component) Component)

This property includes the namespace of the element pointed to by [XPath](#xpath-property-soap-component) .

## Syntax

```text
public string XNamespace { get; }
```

## Default Value

""

## Remarks

The corresponding namespace prefix is provided by [XPrefix](#xprefix-property-soap-component).

This property is read-only.

# XParent Property ([SOAP](#soap-component) Component)

This property includes the parent of the element pointed to by [XPath](#xpath-property-soap-component) .

## Syntax

```text
public string XParent { get; }
```

## Default Value

""

## Remarks

If [XPath](#xpath-property-soap-component) points to the top element, XParent is an empty string.

This property is read-only.

# XPath Property ([SOAP](#soap-component) Component)

This property includes a path into the [SOAPPacket](#soappacket-property-soap-component) received by the server.

## Syntax

```text
public string XPath { get; set; }
```

## Default Value

""

## Remarks

The syntax is a subset of the XPath language.

Use this property to look at details of the [SOAPPacket](#soappacket-property-soap-component) received by the server.

# XPrefix Property ([SOAP](#soap-component) Component)

This property includes the prefix of the element pointed to by [XPath](#xpath-property-soap-component) .

## Syntax

```text
public string XPrefix { get; }
```

## Default Value

""

## Remarks

The corresponding element name is provided by [XElement](#xelement-property-soap-component).

This property is read-only.

# XText Property ([SOAP](#soap-component) Component)

This property includes the text of the element pointed to by [XPath](#xpath-property-soap-component) .

## Syntax

```text
public string XText { get; }
```

## Default Value

""

## Remarks

The [ValueFormat](#valueformat-property-soap-component) property controls the format in which the value is returned.

This property is read-only.

# AddCookie Method ([SOAP](#soap-component) Component)

Adds a cookie and the corresponding value to the outgoing request headers.

## Syntax

```text
public void AddCookie(string cookieName, string cookieValue);

Async Version
public async Task AddCookie(string cookieName, string cookieValue);
public async Task AddCookie(string cookieName, string cookieValue, CancellationToken cancellationToken);
```

## Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the [Cookies](#cookies-property-soap-component) property for more information on cookies and how they are managed.

# AddNamespace Method ([SOAP](#soap-component) Component)

This method adds a namespace to the [Namespaces](#namespaces-property-soap-component) properties.

## Syntax

```text
public void AddNamespace(string prefix, string namespaceURI);

Async Version
public async Task AddNamespace(string prefix, string namespaceURI);
public async Task AddNamespace(string prefix, string namespaceURI, CancellationToken cancellationToken);
```

## Remarks

*Prefix* specifies the namespace prefix, and *NamespaceURI* specifies the namespace.

# AddParam Method ([SOAP](#soap-component) Component)

This method adds a parameter-value pair.

## Syntax

```text
public void AddParam(string paramName, string paramValue);

Async Version
public async Task AddParam(string paramName, string paramValue);
public async Task AddParam(string paramName, string paramValue, CancellationToken cancellationToken);
```

## Remarks

Please refer to the parameter name and value provided in the [Params](#params-property-soap-component) collection for more information on SOAP parameters and how they are managed.

**Example 1. Send SOAP Request:**

```text
SOAPControl.Reset()
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()
```

 **Example 2. Send SOAP Request Using Params Collection:**

```text
SOAPControl.Reset()
SOAPControl.Params.Add(New SOAPParam("paramname", "paramvalue"))
SOAPControl.Params.Add(New SOAPParam("paramname", "paramvalue"))
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()
```

# Attr Method ([SOAP](#soap-component) Component)

This method returns the value of the specified attribute.

## Syntax

```text
public string Attr(string attrName);

Async Version
public async Task<string> Attr(string attrName);
public async Task<string> Attr(string attrName, CancellationToken cancellationToken);
```

## Remarks

If the attribute does not exist, an empty string is returned if [ErrorOnEmptyAttr](#ErrorOnEmptyAttr) is set to False; otherwise, an exception is thrown.

Please refer to the [XAttributes](#xattributes-property-soap-component) collection for more information.

# BuildPacket Method ([SOAP](#soap-component) Component)

This method builds the request packet.

## Syntax

```text
public void BuildPacket();

Async Version
public async Task BuildPacket();
public async Task BuildPacket(CancellationToken cancellationToken);
```

## Remarks

The resulting packet is placed in [SOAPPacket](#soappacket-property-soap-component).

# Config Method ([SOAP](#soap-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-soap-component) for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-soap-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# DoEvents Method ([SOAP](#soap-component) Component)

This method processes events from the internal message queue.

## Syntax

```text
public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);
```

## Remarks

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

# EvalPacket Method ([SOAP](#soap-component) Component)

This method evaluates the packet in [SOAPPacket](#soappacket-property-soap-component) .

## Syntax

```text
public void EvalPacket();

Async Version
public async Task EvalPacket();
public async Task EvalPacket(CancellationToken cancellationToken);
```

## Remarks

Use this method to evaluate SOAP packets received through other means (i.e., not directly through the component).

# HasXPath Method ([SOAP](#soap-component) Component)

This method determines whether a specific element exists in the document.

## Syntax

```text
public bool HasXPath(string XPath);

Async Version
public async Task<bool> HasXPath(string XPath);
public async Task<bool> HasXPath(string XPath, CancellationToken cancellationToken);
```

## Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through [XPath](#xpath-property-soap-component).

This method returns *true* if the *XPath* exists, and *false* if not.

See [XPath](#xpath-property-soap-component) for details on the XPath syntax.

# Interrupt Method ([SOAP](#soap-component) Component)

This method interrupts the current method.

## Syntax

```text
public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);
```

## Remarks

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

# Reset Method ([SOAP](#soap-component) Component)

This method resets the component.

## Syntax

```text
public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
```

## Remarks

Calling this method also resets all HTTP headers to their default values.

# SendPacket Method ([SOAP](#soap-component) Component)

This method sends the packet.

## Syntax

```text
public void SendPacket();

Async Version
public async Task SendPacket();
public async Task SendPacket(CancellationToken cancellationToken);
```

## Remarks

This method may also be used to send a packet placed in [SOAPPacket](#soappacket-property-soap-component).

**Example. Send SOAP Request:**

```text
SOAPControl.Reset()
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.BuildPacket()
SOAPControl.SendPacket()
SOAPControl.EvalPacket()
```

# SendRequest Method ([SOAP](#soap-component) Component)

This method sends the request.

## Syntax

```text
public void SendRequest();

Async Version
public async Task SendRequest();
public async Task SendRequest(CancellationToken cancellationToken);
```

## Remarks

Calling this method is equivalent to calling [BuildPacket](#buildpacket-method-soap-component), [SendPacket](#sendpacket-method-soap-component), and [EvalPacket](#evalpacket-method-soap-component) in succession.

**Example. Send SOAP Request:**

```text
SOAPControl.Reset()
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()
```

# TryXPath Method ([SOAP](#soap-component) Component)

This method navigates to the specified XPath if it exists.

## Syntax

```text
public bool TryXPath(string xpath);

Async Version
public async Task<bool> TryXPath(string xpath);
public async Task<bool> TryXPath(string xpath, CancellationToken cancellationToken);
```

## Remarks

This method will attempt to navigate to the specified *XPath* parameter if it exists within the document.

If the XPath exists, the [XPath](#xpath-property-soap-component) property will be updated and this method returns *true*.

If the XPath does not exist, the [XPath](#xpath-property-soap-component) property is not updated and this method returns *false*.

# Value Method ([SOAP](#soap-component) Component)

This method returns the value of a parameter.

## Syntax

```text
public string Value(string paramName);

Async Version
public async Task<string> Value(string paramName);
public async Task<string> Value(string paramName, CancellationToken cancellationToken);
```

## Remarks

The component will search through the [Params](#params-property-soap-component) collection for the parameter identified by *ParamName* and will return the value associated with it provided in the collection.

# Connected Event ([SOAP](#soap-component) Component)

Fired immediately after a connection completes (or fails).

## Syntax

```text
public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, SOAPConnectedEventArgs e);

public class SOAPConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

If the connection is made normally, *StatusCode* is 0 and *Description* is "OK".

If the connection fails, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error.

Please refer to the [Error Codes](#trappable-errors-soap-component) section for more information.

# ConnectionStatus Event ([SOAP](#soap-component) Component)

Fired to indicate changes in the connection state.

## Syntax

```text
public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, SOAPConnectionStatusEventArgs e);

public class SOAPConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following:

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | SSL or S/Shell connection broken. |
|  | Firewall host disconnected. |

 *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error.

# Disconnected Event ([SOAP](#soap-component) Component)

Fired when a connection is closed.

## Syntax

```text
public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, SOAPDisconnectedEventArgs e);

public class SOAPDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK".

If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error.

Please refer to the [Error Codes](#trappable-errors-soap-component) section for more information.

# EndTransfer Event ([SOAP](#soap-component) Component)

This event is fired when a document finishes transferring.

## Syntax

```text
public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, SOAPEndTransferEventArgs e);

public class SOAPEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}
```

## Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The *Direction* parameter shows whether the client (0) or the server (1) is sending the data.

# Error Event ([SOAP](#soap-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

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

public class SOAPErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

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

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-soap-component) section.

# Header Event ([SOAP](#soap-component) Component)

Fired every time a header line comes in.

## Syntax

```text
public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, SOAPHeaderEventArgs e);

public class SOAPHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}
```

## Remarks

The *Field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *Value* parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string).

# Log Event ([SOAP](#soap-component) Component)

Fired once for each log message.

## Syntax

```text
public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, SOAPLogEventArgs e);

public class SOAPLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}
```

## Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

*LogLevel* indicates the level of message. Possible values are as follows:

|  |  |
| --- | --- |
| 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).

*Message* is the log entry.

*LogType* identifies the type of log entry. Possible values are as follows:

- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"

# Redirect Event ([SOAP](#soap-component) Component)

Fired when a redirection is received from the server.

## Syntax

```text
public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, SOAPRedirectEventArgs e);

public class SOAPRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}
```

## Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The *Accept* parameter is always True by default, but if you do not want to follow the redirection, *Accept* may be set to False, in which case the component throws an exception. *Location* is the location to which the client is being redirected. Further control over redirection is provided in the [FollowRedirects](#followredirects-property-soap-component) property.

# SetCookie Event ([SOAP](#soap-component) Component)

Fired for every cookie set by the server.

## Syntax

```text
public event OnSetCookieHandler OnSetCookie;

public delegate void OnSetCookieHandler(object sender, SOAPSetCookieEventArgs e);

public class SOAPSetCookieEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public string Expires { get; }
  public string Domain { get; }
  public string Path { get; }
  public bool Secure { get; }
}
```

## Remarks

This event is fired for every *Set-Cookie:* header received from the HTTP server.

The *Name* parameter contains the name of the cookie, with the corresponding value supplied in the *Value* parameter.

The *Expires* parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the *Expires* parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The *Domain* parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the *Domain* parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The *Path* parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the *Path* parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The *Secure* parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

# SSLServerAuthentication Event ([SOAP](#soap-component) Component)

Fired after the server presents its certificate to the client.

## Syntax

```text
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, SOAPSSLServerAuthenticationEventArgs e);

public class SOAPSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}
```

## 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 ([SOAP](#soap-component) Component)

Fired when secure connection progress messages are available.

## Syntax

```text
public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, SOAPSSLStatusEventArgs e);

public class SOAPSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# StartTransfer Event ([SOAP](#soap-component) Component)

This event is fired when a document starts transferring (after the headers).

## Syntax

```text
public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, SOAPStartTransferEventArgs e);

public class SOAPStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}
```

## Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The *Direction* parameter shows whether the client (0) or the server (1) is sending the data.

# Status Event ([SOAP](#soap-component) Component)

Fired when the HTTP status line is received from the server.

## Syntax

```text
public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, SOAPStatusEventArgs e);

public class SOAPStatusEventArgs : EventArgs {
  public string HTTPVersion { get; }
  public int StatusCode { get; }
  public string Description { get; }
}
```

## Remarks

*HTTPVersion* is a string containing the HTTP version string as returned from the server (e.g., "1.1").

*StatusCode* contains the HTTP status code (e.g., 200), and *Description* the associated message returned by the server (e.g., "OK").

# Transfer Event ([SOAP](#soap-component) Component)

This event is fired while the response transfers.

## Syntax

```text
public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, SOAPTransferEventArgs e);

public class SOAPTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
}
```

## Remarks

The *BytesTransferred* parameter contains the number of bytes transferred since the beginning of the response (excluding HTTP response headers).

The *Direction* parameter shows whether the client (0) or the server (1) is sending the data.

The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1.

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

# Certificate Type

This is the digital certificate being used.

## Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *string (read-only)*
Default: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

 **ExpirationDate** *string (read-only)*
Default: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *string (read-only)*
Default: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **Fingerprint** *string (read-only)*
Default: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

 **FingerprintSHA1** *string (read-only)*
Default: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

 **FingerprintSHA256** *string (read-only)*
Default: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

 **Issuer** *string (read-only)*
Default: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

 **PrivateKey** *string (read-only)*
Default: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *bool (read-only)*
Default: False

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *string (read-only)*
Default: ""

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *string (read-only)*
Default: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **PublicKeyAlgorithm** *string (read-only)*
Default: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

 **PublicKeyLength** *int (read-only)*
Default: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **SerialNumber** *string (read-only)*
Default: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

 **SignatureAlgorithm** *string (read-only)*
Default: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

 **Store** *string*
Default: "MY"

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StoreB** *byte []*
Default: "MY"

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StorePassword** *string*
Default: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

 **StoreType** *CertStoreTypes*
Default: 0

The type of certificate store for this certificate.

 The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This field can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 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, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 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. |

 **SubjectAltNames** *string (read-only)*
Default: ""

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *string (read-only)*
Default: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA1** *string (read-only)*
Default: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA256** *string (read-only)*
Default: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **Usage** *string (read-only)*
Default: ""

The text description of [UsageFlags](#Certificate_f_UsageFlags).

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

 **UsageFlags** *int (read-only)*
Default: 0

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

This functionality currently is not available when the provider is OpenSSL.

 **Version** *string (read-only)*
Default: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **Subject** *string*
Default: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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=example@email.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.

 **Encoded** *string*
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

 **EncodedB** *byte []*
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(string certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# Firewall Type

The firewall the component will connect through.

## Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType).

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *bool*
Default: False

Whether to automatically detect and use firewall system settings, if available.

 **FirewallType** *FirewallTypes*
Default: 0

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](#Firewall_f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. |

 **Host** *string*
Default: ""

The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting.

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

 **Password** *string*
Default: ""

A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

 **Port** *int*
Default: 0

The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details.

NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details.

 **User** *string*
Default: ""

A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component throws an exception.

## Constructors

```text
public Firewall();
```

# Header Type

This is an HTTP header as it is received from the server.

## Remarks

When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value).

The following fields are available:

- [Field](#Header_f_Field)

- [Value](#Header_f_Value)

## Fields

 **Field** *string*
Default: ""

This field contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered).

 **Value** *string*
Default: ""

This field contains the [Header](#header-type) contents.

## Constructors

```text
public Header();
```

```text
public Header(string field, string value);
```

# HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

## Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the [Name](#HTTPCookie_f_Name) and [Value](#HTTPCookie_f_Value) fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an **HTTPCookie** are filled out accordingly.

The following fields are available:

- [Domain](#HTTPCookie_f_Domain)

- [Expiration](#HTTPCookie_f_Expiration)

- [Name](#HTTPCookie_f_Name)

- [Path](#HTTPCookie_f_Path)

- [Secure](#HTTPCookie_f_Secure)

- [Value](#HTTPCookie_f_Value)

## Fields

 **Domain** *string (read-only)*
Default: ""

The domain of a received cookie. This field contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this field will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

 **Expiration** *string (read-only)*
Default: ""

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this field will contain an empty string. The convention is to drop the cookie at the end of the session.

 **Name** *string*
Default: ""

The name of the cookie.

This field, along with [Value](#HTTPCookie_f_Value), stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

 **Path** *string (read-only)*
Default: ""

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path field will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

 **Secure** *bool (read-only)*
Default: False

The security flag of the received cookie. This field specifies whether the cookie is secure. If the value of this field is True, the cookie value must be submitted only through a secure (HTTPS) connection.

 **Value** *string*
Default: ""

The value of the cookie. A corresponding value is associated with the cookie specified by [Name](#HTTPCookie_f_Name). This property holds that value.

The SetCookie event provides the cookies set by the server.

## Constructors

```text
public HTTPCookie();
```

```text
public HTTPCookie(string name, string value);
```

# Proxy Type

The proxy the component will connect to.

## Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme).

The following fields are available:

- [AuthScheme](#Proxy_f_AuthScheme)

- [AutoDetect](#Proxy_f_AutoDetect)

- [Password](#Proxy_f_Password)

- [Port](#Proxy_f_Port)

- [Server](#Proxy_f_Server)

- [SSL](#Proxy_f_SSL)

- [User](#Proxy_f_User)

## Fields

 **AuthScheme** *ProxyAuthSchemes*
Default: 0

The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set.

[AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected.

By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the component will attempt basic authentication.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password).

 **AutoDetect** *bool*
Default: False

Whether to automatically detect and use proxy system settings, if available. The default value is *false*.

 **Password** *string*
Default: ""

A password if authentication is to be used for the proxy.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

 **Port** *int*
Default: 80

The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details.

 **Server** *string*
Default: ""

If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned.

 **SSL** *ProxySSLTypes*
Default: 0

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 component will use the psTunnel option. If the URL is an http URL, the component 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. |

 **User** *string*
Default: ""

A username if authentication is to be used for the proxy.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

## Constructors

```text
public Proxy();
```

```text
public Proxy(string server, int port);
```

```text
public Proxy(string server, int port, string user, string password);
```

# SOAPParam Type

This type describes a parameter for the SOAP .

## Remarks

This type describes a parameter of the SOAP [Method](#method-property-soap-component). [SOAPParam](#soapparam-type) has fields to describe the name, value, and any attributes of the parameter being described.

The following fields are available:

- [Attrs](#SOAPParam_f_Attrs)

- [Name](#SOAPParam_f_Name)

- [Value](#SOAPParam_f_Value)

## Fields

 **Attrs** *string*
Default: ""

This field contains the extra attributes for the parameter.

 **Name** *string*
Default: ""

This field contains the name of the [Method](#method-property-soap-component) parameter.

 **Value** *string*
Default: ""

This field contains the value of the [Method](#method-property-soap-component) parameter.

## Constructors

```text
public SOAPParam();
```

```text
public SOAPParam(string name, string value);
```

# XMLAttribute Type

This type describes an XML attribute from the current XML element.

## Remarks

This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined.

The following fields are available:

- [Name](#XMLAttribute_f_Name)

- [Namespace](#XMLAttribute_f_Namespace)

- [Prefix](#XMLAttribute_f_Prefix)

- [Value](#XMLAttribute_f_Value)

## Fields

 **Name** *string (read-only)*
Default: ""

The [Name](#XMLAttribute_f_Name) provides the local name (without prefix) of the attribute.

 **Namespace** *string (read-only)*
Default: ""

This field contains the attribute namespace.

 **Prefix** *string (read-only)*
Default: ""

This field contains the attribute prefix (if any). If the attribute does not have a prefix, this field is empty.

 **Value** *string (read-only)*
Default: ""

This field contains the attribute value.

## Constructors

```text
public XMLAttribute();
```

# XMLElement Type

This type describes an element contained within the XML document.

## Remarks

This type describes an XML element. The fields for this type describe the element [Name](#XMLElement_f_Name), [Prefix](#XMLElement_f_Prefix), and [Namespace](#XMLElement_f_Namespace) of the given element.

The elements are inserted into the array in the same order they are found in the document.

The following fields are available:

- [Name](#XMLElement_f_Name)

- [Namespace](#XMLElement_f_Namespace)

- [Prefix](#XMLElement_f_Prefix)

- [XText](#XMLElement_f_XText)

## Fields

 **Name** *string (read-only)*
Default: ""

The [Name](#XMLElement_f_Name) field provides the local name (without a prefix) of the element.

 **Namespace** *string (read-only)*
Default: ""

This field contains the namespace of the element.

 **Prefix** *string (read-only)*
Default: ""

This field contains the prefix of the element (if any). If the element does not have a prefix, this field is empty.

 **XText** *string (read-only)*
Default: ""

This field contains the inner text of the element.

## Constructors

```text
public XMLElement();
```

# XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

## Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the [Prefix](#XMLNamespace_f_Prefix) and the [URI](#XMLNamespace_f_URI) of the namespace being defined.

The default namespace exists at index *0*. The [Prefix](#XMLNamespace_f_Prefix) field at index *0* is *xmlns*, and the [Name](#XMLNamespace_f_Name) field contains the default namespace.

The following fields are available:

- [Prefix](#XMLNamespace_f_Prefix)

- [URI](#XMLNamespace_f_URI)

## Fields

 **Prefix** *string*
Default: ""

This field contains the [Prefix](#XMLNamespace_f_Prefix) for the namespace.

 **URI** *string*
Default: ""

This field contains the namespace URI associated with the corresponding [Prefix](#XMLNamespace_f_Prefix). This URL is usually pointing to the XML schema for the namespace.

## Constructors

```text
public XMLNamespace();
```

```text
public XMLNamespace(string URI, string prefix);
```

# Config Settings ([SOAP](#soap-component) Component)

 The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-soap-component) method.

### SOAP Config Settings

**ActionURISeparator**: The separator between the namespace and the method name in the SOAP Action URI. The [ActionURI](#actionuri-property-soap-component) property is constructed from the method namespace, this separator, and the method name. The default separator is "#"; change this setting if the target server requires a different value.

**EncodingStyleNamespacePrefix**: The prefix to be used for the Encoding namespace. It should not matter what this prefix is set to, but some servers seem to be picky; so please use a value that is acceptable.

**MethodAttributes**: The attributes to include in the method element.When forming the SOAP packet, the component will include the value specified here as an attribute of the method element. This is empty string by default and no attributes will be included. When specifying an attribute to be included, the attribute should be surrounded by quotes. For instance:

```text
SOAP1.Config("MethodAttributes=\"<your value>\"");
```

**MethodNamespacePrefix**: The prefix to be used for the Method namespace. By default, the component assumes you are consuming an RPC service and sets its method namespace prefix to "m". If you need to change this, you can set the MethodNamespacePrefix configuration setting. If your service is a SoapDocument service and you do not need to use a prefix at all, you can set the MethodNamespacePrefix configuration setting to an empty string.

**RequestPacket**: The SOAP packet that was sent to the server during the last request. Accessing the RequestPacket configuration setting allows a user to view the raw SOAP packet that was sent to the server during the last request.

**XSubTree**: A snapshot of the current element in the document. The current element is specified through the [XPath](#xpath-property-soap-component) property. You may then query this setting.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the component adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The component only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms.

When True, the component adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.

The default value is True.

**AllowNTLMFallback**: Whether to allow fallback from Negotiate to NTLM when authenticating.This configuration setting applies only when [AuthScheme](#authscheme-property-soap-component) is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. NOTE: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [LocalFile](#localfile-property-soap-component). When set to True, downloaded data will be appended to [LocalFile](#localfile-property-soap-component). This may be used in conjunction with Range to resume a failed download. This is applicable only when [LocalFile](#localfile-property-soap-component) is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The [AuthScheme](#authscheme-property-soap-component) property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [User](#user-property-soap-component) and [Password](#password-property-soap-component) are set, they are Base64 encoded, and the result is put in the [Authorization](#authorization-property-soap-component) property in the form "Basic [encoded-user-password]".

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-soap-component) event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the component.If set to True, the URL passed to the component will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new [URL](#url-property-soap-component) for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new [URL](#url-property-soap-component) is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.

**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](#user-property-soap-component) and [Password](#password-property-soap-component) 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](#redirect-event-soap-component) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-soap-component) 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 component throws an exception instead.

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the component will perform a GET on the new location.The default value is False. If set to True, the component will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the component.This property specifies the HTTP version used by the component. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.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 component 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](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.

**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.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-soap-component) event. Possible values are as follows:

|  |  |
| --- | --- |
| 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).

**MaxHeaders**: Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.This configuration setting should be set when the [TransferredHeaders](#transferredheaders-property-soap-component) collection is to be populated when a [Header](#header-event-soap-component) event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

**MaxHTTPCookies**: Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.This configuration setting should be set when populating the [Cookies](#cookies-property-soap-component) collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-soap-component) is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) .

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 component beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme).

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by components that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the component.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

**UsePlatformDeflate**: Whether to use the platform implementation to decompress compressed responses.This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to *True* (default), the platform implementation is used. If set to *False*, an internal implementation is used.

**UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*.

When *True* (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use [Timeout](#timeout-property-soap-component) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the component whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by components that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#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 components that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the [ConnectionStatus](#connectionstatus-event-soap-component) event.

The connection to the firewall is made by calling the Connect method.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

NOTE: This setting is provided for use by components that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#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](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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 component 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.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-soap-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

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

If the component is connected, the [LocalHost](#localhost-property-soap-component) 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 multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#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](#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](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

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

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**CACertFilePaths**: The paths to CA certificate files when using Mono on Unix/Linux.This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

*/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem*

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-soap-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-soap-component) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-soap-component) is set to *Platform*.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the component 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 component is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-soap-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-soap-component) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.

When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-soap-component) event.

Use this configuration 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#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](#sslprovider-property-soap-component) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#sslprovider-property-soap-component) is set to *Platform* include the following:

- 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

 Example values when [SSLProvider](#sslprovider-property-soap-component) is set to *Internal*include the following:

```text
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_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-soap-component) is set to *Internal* include the following:

- 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_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](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the component will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-soap-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-soap-component) 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 supported only 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 available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these 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 component when the [SSLProvider](#sslprovider-property-soap-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-soap-component) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#sslprovider-property-soap-component) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-soap-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-soap-component) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-soap-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When [SSLProvider](#sslprovider-property-soap-component) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the component 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 traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-soap-component) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 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 non-matching server name). |

This functionality is currently not available in Java or when the provider is OpenSSL.

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-soap-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
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 configuration 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*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#sslprovider-property-soap-component) 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)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

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 configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only 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"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "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 *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

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)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-soap-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

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

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

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

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

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

### XML Config Settings

**CacheContent**: If true, the original XML is saved in a buffer.This configuration setting controls whether or not the component retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is *true*.

**Charset**: Specifies the charset used when encoding data.This configuration setting specifies the character set used when encoding data. This value will also be used when creating the XMLDeclaration. The default value is *utf-8*.

**CloseInputStreamAfterProcess**: Determines whether or not the input stream is closed after processing.This configuration setting determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is *true*.

**CloseOutputStreamAfterProcess**: Determines whether or not the output stream is closed after processing.This configuration setting determines whether or not the output stream set by SetOutputStream is closed after processing is complete. The default value is *true*.

**EOL**: The characters to use for separating lines.If specified, the component will format the output XML using the specified characters to separate multiple lines for nested XML elements. The default value is CRLF (*"\r\n"*) .

This option should be combined with [Indent](#Indent) for full effect.

**ErrorOnEmptyAttr**: If true, passing an invalid attribute to the GetAttr method will throw an exception.If an invalid attribute name is passed to the GetAttr method, the method will return an empty string if this is set to *false*; otherwise, an exception is thrown.

**ExtraNameChars**: Extra characters for the parser to consider as name characters.Normally, the parser considers only the following characters as part of an XML identifier: *A* through *Z*, *a* through *z*, *0* through *9*, *0x0300* through *0x036F*, *0x203F* through *0x2040*, and *.*, *-*, *_*, and *:*.

If you would like any other characters to be considered as name characters, you may set them as a string into this property.

**ExtraSpaceChars**: Extra characters for the parser to consider as whitespace.Normally, the parser considers only the following characters as whitespace: * * (space), *\t* (tab), *\n* (newline), *\r* (carriage return), *\f* (form feed), and *\v* (vertical tab).

If you would like any other characters to be considered as whitespace, you may set them as a string into this property.

**FlushOnEOL**: If set, the parser flushes its text buffer after every line of text.The [FlushOnEOL](#FlushOnEOL) property controls whether or not Characters events are fired for every line of the input text stream. Normally, lines are buffered internally and delivered in batches, but if the [FlushOnEOL](#FlushOnEOL) flag is set, then a Characters event is fired for each line.

**IgnoreBadAttributePrefixes**: If true, bad (unknown) attribute prefixes are ignored.Normally a trappable error is generated when an unknown attribute prefix is encountered. This configuration setting suppresses the error. The default value is *true*.

**IgnoreBadElementPrefixes**: If true, bad (unknown) element prefixes are ignored.Normally a trappable error is generated when an unknown element prefix is encountered. This configuration setting suppresses the error. The default value is *true*.

**IncludeElementPrefix**: Whether to include the prefix in the element name.This configuration setting specifies whether or not to include the element prefix in the *Element* parameter of the StartElement and EndElement events.

If *false* (default) and Validate is set to *false*, the prefix is included in the *Element* parameter (e.g., *ds:DigestMethod*).

If *true* and Validate is set to *false*, the prefix is not included in the *Element* parameter (e.g., *DigestMethod*).

This setting is applicable only when Validate is *false*.

**IncludeXMLDeclaration**: Whether to include the XML declaration when writing XML.This configuration setting specifies whether the XML declaration is included in the output XML when writing XML. When set to *true* (default), the XML declaration will be included above any user-specified XML. For instance:

```text
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...
```

**Indent**: The characters to use for each indentation level.If specified, the component will format the output XML using the specified characters to denote each indentation level for nested XML elements.

This option should be combined with [EOL](#EOL) for full effect.

**Interrupt**: Whether to stop parsing the current XML document.This configuration setting can be called from within any event to stop further parsing of the document. The configuration setting only works from within events. For example:

```text
void xml_OnStartElement(object sender, XMLStartElementEventArgs e)
{
  xml.Config("Interrupt");
}
```

**Offset**: Current offset of the document being parsed.This property is useful for determining the location of possible XML errors in the document.

[Offset](#Offset) values start at *1*.

**PreserveAll**: Whether to preserve processing instructions and comments.When set to *true*, the parser will preserve all processing instructions and comments of the input. The default value is *false*.

This configuration setting can be used together with [ProcessNamespace](#ProcessNamespace) when filling XML templates.

**PreserveWhitespace**: If true, leading and trailing whitespace in element text is preserved.Normally, the leading and trailing whitespace from an element's text is trimmed. When this property is set to *true*, this leading and trailing whitespace is preserved. The default value is *false*.

**ProcessNamespace**: Whether the parser will process namespaces.When set to *false*, namespaces will not be parsed or processed. This allows the original namespace information to be preserved as it appeared in the input. The default value is *true*.

This configuration setting can be used together with [PreserveAll](#PreserveAll) when filling XML templates.

**QuoteChar**: Quote character to use for attribute values.By default, the component will use double quotes around attribute values. This property can be used to specify a different character, such as a single quote.

**StringProcessingOptions**: Defines options to use when processing string values.This configuration setting determines what additional processing is performed on string values fired through the Characters event.

NOTE: This applies only when BuildDOM is *false*.

By default, no additional processing is performed and the string is returned as is from the document. Strings may also be XML unescaped. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (none - default) | No additional processing is performed. |
| 1 | Strings are XML unescaped. |

For instance, when set to *0*, the following text may be fired through the Characters event:

*&"<>*

When set to *1*, the following text would be fired through the Characters event:

*&"<>*

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

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

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

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

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

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

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

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

# Trappable Errors ([SOAP](#soap-component) Component)

### SOAP Errors

|  |  |
| --- | --- |
| 169 | Invalid param index (out of range). |
| 170 | Invalid namespace index (out of range). |
| 171 | [Method](#method-property-soap-component) not found. Please specify a valid [Method](#method-property-soap-component). |
| 172 | No method URI. Please specify a valid [MethodURI](#methoduri-property-soap-component). |
| 173 | SOAP Fault. See [FaultCode](#faultcode-property-soap-component) and/or [FaultString](#faultstring-property-soap-component) for details. |

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

### HTTP Errors

|  |  |
| --- | --- |
| 118 | Firewall error. The error description contains the detailed message. |
| 143 | Busy executing current method. |
| 151 | HTTP protocol error. The error message has the server response. |
| 152 | No server specified in [URL](#url-property-soap-component). |
| 153 | Specified URLScheme is invalid. |
| 155 | Range operation is not supported by server. |
| 156 | Invalid cookie index (out of range). |
| 301 | Interrupted. |
| 302 | Cannot open AttachedFile. |

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

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the RemotePort at this time. A connection is in progress. |
| 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 102 | The RemoteHost address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the LocalPort at this time. A connection is in progress. |
| 107 | You cannot change the [LocalHost](#localhost-property-soap-component) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | RemotePort cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the component is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 303 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |

### XML Errors

|  |  |
| --- | --- |
| 101 | Invalid attribute index. |
| 102 | No attributes available. |
| 103 | Invalid namespace index. |
| 104 | No namespaces available. |
| 105 | Invalid element index. |
| 106 | No elements available. |
| 107 | Attribute does not exist. |
| 201 | Unbalanced element tag. |
| 202 | Unknown element prefix (cannot find namespace). |
| 203 | Unknown attribute prefix (cannot find namespace). |
| 204 | Invalid XML markup. |
| 205 | Invalid end state for parser. |
| 206 | Document contains unbalanced elements. |
| 207 | Invalid [XPath](#xpath-property-soap-component). |
| 208 | No such child. |
| 209 | Top element does not match start of path. |
| 210 | DOM tree unavailable (set BuildDOM to true and reparse). |
| 302 | Cannot open file. |
| 401 | Invalid XML would be generated. |
| 402 | An invalid XML name has been specified. |