SOAP Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SOAP

Remarks

The SOAP Control 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 event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

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

The control 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 and MethodURI, as well as optional parameters in the Params properties. Then set the target URL and call the SendRequest method.

The results will be provided through the ReturnValue property and the Params properties (for output parameters). Additionally, properties such as XPath, XElement, and XText allow for more granular traversal of the SOAP response.

If the server returns an error, the FaultCode, FaultString, and FaultActor properties will provide information about the error condition.

The control may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket. The corresponding SOAP packet will be stored in the SOAPPacket 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 control allows for possible extension and full control over the SOAPPacket. The SendPacket method may then be used to send the custom-created SOAPPacket to the destination URL.

Property List

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

Method List

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

Event List

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

Config Settings

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

Accept Property (SOAP Control)

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

Syntax

soapcontrol.Accept[=string]

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.

Data Type

String

ActionURI Property (SOAP Control)

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

Syntax

soapcontrol.ActionURI[=string]

Default Value

""

Remarks

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.

Data Type

String

Authorization Property (SOAP Control)

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

Syntax

soapcontrol.Authorization[=string]

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 control can be extended with other security schemes in addition to the authorization schemes already implemented by the control.

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

Data Type

String

AuthScheme Property (SOAP Control)

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

Syntax

soapcontrol.AuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5), 
authOAuth(6)

Default Value

0

Remarks

This property will tell the control which type of authorization to perform when the User and Password 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 and Password properties are set, the control 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 property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the control.

For security, changing the value of this property will cause the control to clear the values of User, Password, and Authorization.

Data Type

Integer

Connected Property (SOAP Control)

Whether the control is connected.

Syntax

soapcontrol.Connected

Default Value

False

Remarks

This property is used to determine whether or not the control 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.

Data Type

Boolean

ContentType Property (SOAP Control)

This property includes the content type for SOAP request data.

Syntax

soapcontrol.ContentType[=string]

Default Value

"text/xml"

Remarks

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

This property is not available at design time.

Data Type

String

CookieCount Property (SOAP Control)

The number of records in the Cookie arrays.

Syntax

soapcontrol.CookieCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (SOAP Control)

The domain of a received cookie.

Syntax

soapcontrol.CookieDomain(CookieIndex)

Default Value

""

Remarks

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

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieExpiration Property (SOAP Control)

An expiration time for the cookie (if provided by the server).

Syntax

soapcontrol.CookieExpiration(CookieIndex)

Default Value

""

Remarks

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 property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieName Property (SOAP Control)

The name of the cookie.

Syntax

soapcontrol.CookieName(CookieIndex)[=string]

Default Value

""

Remarks

The name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (SOAP Control)

A path name to limit the cookie to (if provided by the server).

Syntax

soapcontrol.CookiePath(CookieIndex)

Default Value

""

Remarks

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

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieSecure Property (SOAP Control)

The security flag of the received cookie.

Syntax

soapcontrol.CookieSecure(CookieIndex)

Default Value

False

Remarks

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

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

Boolean

CookieValue Property (SOAP Control)

The value of the cookie.

Syntax

soapcontrol.CookieValue(CookieIndex)[=string]

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

FaultActor Property (SOAP Control)

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

Syntax

soapcontrol.FaultActor

Default Value

""

Remarks

FaultCode and FaultString provide the corresponding fault code and description.

This property is read-only.

Data Type

String

FaultCode Property (SOAP Control)

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

Syntax

soapcontrol.FaultCode

Default Value

""

Remarks

FaultString and FaultActor provide the corresponding fault description and actor.

This property is read-only.

Data Type

String

FaultString Property (SOAP Control)

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

Syntax

soapcontrol.FaultString

Default Value

""

Remarks

FaultCode and FaultActor provide the corresponding fault code and actor.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (SOAP Control)

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

Syntax

soapcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (SOAP Control)

The type of firewall to connect through.

Syntax

soapcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SOAP Control)

The name or IP address of the firewall (optional).

Syntax

soapcontrol.FirewallHost[=string]

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (SOAP Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

soapcontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (SOAP Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

soapcontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (SOAP Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

soapcontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

FollowRedirects Property (SOAP Control)

Determines what happens when the server issues a redirect.

Syntax

soapcontrol.FollowRedirects[=integer]

Possible Values

frNever(0), 
frAlways(1), 
frSameScheme(2)

Default Value

0

Remarks

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

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the control fails with an error.

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 and Password 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 event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the control fails with an error instead.

Data Type

Integer

Idle Property (SOAP Control)

The current status of the control.

Syntax

soapcontrol.Idle

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.

Data Type

Boolean

IfModifiedSince Property (SOAP Control)

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

Syntax

soapcontrol.IfModifiedSince[=string]

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

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.

Data Type

String

LocalFile Property (SOAP Control)

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

Syntax

soapcontrol.LocalFile[=string]

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through TransferredData and the Transfer event.

Data Type

String

LocalHost Property (SOAP Control)

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

Syntax

soapcontrol.LocalHost[=string]

Default Value

""

Remarks

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

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

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

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

Data Type

String

Method Property (SOAP Control)

This property includes the remote Method .

Syntax

soapcontrol.Method[=string]

Default Value

""

Remarks

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.

Data Type

String

MethodURI Property (SOAP Control)

This property includes the URI corresponding to the SOAP Method .

Syntax

soapcontrol.MethodURI[=string]

Default Value

""

Remarks

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.

Data Type

String

NamespaceCount Property (SOAP Control)

The number of records in the Namespace arrays.

Syntax

soapcontrol.NamespaceCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (SOAP Control)

This property contains the Prefix for the Namespace .

Syntax

soapcontrol.NamespacePrefix(NamespaceIndex)[=string]

Default Value

""

Remarks

This property contains the NamespacePrefix for the Namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (SOAP Control)

This property contains the namespace URI associated with the corresponding Prefix .

Syntax

soapcontrol.NamespaceURI(NamespaceIndex)[=string]

Default Value

""

Remarks

This property contains the namespace URI associated with the corresponding NamespacePrefix. This URL is usually pointing to the XML schema for the namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

OtherHeaders Property (SOAP Control)

Other headers as determined by the user (optional).

Syntax

soapcontrol.OtherHeaders[=string]

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 and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .

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

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

This property is not available at design time.

Data Type

String

ParamCount Property (SOAP Control)

The number of records in the Param arrays.

Syntax

soapcontrol.ParamCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParamAttrs
• ParamName
• ParamValue

The array indices start at 0 and end at ParamCount - 1.

This property is not available at design time.

Data Type

Integer

ParamAttrs Property (SOAP Control)

This property contains the extra attributes for the parameter.

Syntax

soapcontrol.ParamAttrs(ParamIndex)[=string]

Default Value

""

Remarks

This property contains the extra attributes for the parameter.

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String

ParamName Property (SOAP Control)

This property contains the name of the Method parameter.

Syntax

soapcontrol.ParamName(ParamIndex)[=string]

Default Value

""

Remarks

This property contains the name of the Method parameter.

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String

ParamValue Property (SOAP Control)

This property contains the value of the Method parameter.

Syntax

soapcontrol.ParamValue(ParamIndex)[=string]

Default Value

""

Remarks

This property contains the value of the Method parameter.

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (SOAP Control)

The number of records in the ParsedHeader arrays.

Syntax

soapcontrol.ParsedHeaderCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (SOAP Control)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

soapcontrol.ParsedHeaderField(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (SOAP Control)

This property contains the header contents.

Syntax

soapcontrol.ParsedHeaderValue(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

Password Property (SOAP Control)

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

Syntax

soapcontrol.Password[=string]

Default Value

""

Remarks

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

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the control will attempt to authenticate using the current user's credentials.

Data Type

String

Pragma Property (SOAP Control)

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

Syntax

soapcontrol.Pragma[=string]

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.

Data Type

String

ProxyAuthScheme Property (SOAP Control)

The type of authorization to perform when connecting to the proxy.

Syntax

soapcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

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

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (SOAP Control)

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

Syntax

soapcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (SOAP Control)

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

Syntax

soapcontrol.ProxyPassword[=string]

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (SOAP Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

soapcontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (SOAP Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

soapcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

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

Data Type

String

ProxySSL Property (SOAP Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

soapcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (SOAP Control)

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

Syntax

soapcontrol.ProxyUser[=string]

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Referer Property (SOAP Control)

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

Syntax

soapcontrol.Referer[=string]

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.

Data Type

String

ReturnValue Property (SOAP Control)

This property includes the value returned by the SOAP Method .

Syntax

soapcontrol.ReturnValue

Default Value

""

Remarks

ReturnValue corresponds to the first item in the Params properties.

This property is read-only.

Data Type

String

SOAPEncoding Property (SOAP Control)

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

Syntax

soapcontrol.SOAPEncoding[=string]

Default Value

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

Remarks

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

Data Type

String

SOAPHeader Property (SOAP Control)

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

Syntax

soapcontrol.SOAPHeader[=string]

Default Value

""

Remarks

This property is used only when building SOAP requests.

This property is not available at design time.

Data Type

String

SOAPPacket Property (SOAP Control)

This property includes the full contents of the SOAP packet.

Syntax

soapcontrol.SOAPPacket[=string]

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.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (SOAP Control)

The date on which this certificate becomes valid.

Syntax

soapcontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (SOAP Control)

The date on which the certificate expires.

Syntax

soapcontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (SOAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

soapcontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (SOAP Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (SOAP Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (SOAP Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (SOAP Control)

The issuer of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (SOAP Control)

The private key of the certificate (if available).

Syntax

soapcontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

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

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (SOAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

soapcontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (SOAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

soapcontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (SOAP Control)

The public key of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (SOAP Control)

The textual description of the certificate's public key algorithm.

Syntax

soapcontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (SOAP Control)

The length of the certificate's public key (in bits).

Syntax

soapcontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (SOAP Control)

The serial number of the certificate encoded as a string.

Syntax

soapcontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (SOAP Control)

The text description of the certificate's signature algorithm.

Syntax

soapcontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (SOAP Control)

The name of the certificate store for the client certificate.

Syntax

soapcontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (SOAP Control)

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

Syntax

soapcontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (SOAP Control)

The type of certificate store for this certificate.

Syntax

soapcontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (SOAP Control)

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

Syntax

soapcontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (SOAP Control)

The MD5 hash of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (SOAP Control)

The SHA-1 hash of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (SOAP Control)

The SHA-256 hash of the certificate.

Syntax

soapcontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (SOAP Control)

The text description of UsageFlags .

Syntax

soapcontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (SOAP Control)

The flags that show intended use for the certificate.

Syntax

soapcontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (SOAP Control)

The certificate's version number.

Syntax

soapcontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (SOAP Control)

The subject of the certificate used for client authentication.

Syntax

soapcontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (SOAP Control)

The certificate (PEM/Base64 encoded).

Syntax

soapcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (SOAP Control)

The date on which this certificate becomes valid.

Syntax

soapcontrol.SSLCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (SOAP Control)

The date on which the certificate expires.

Syntax

soapcontrol.SSLCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (SOAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

soapcontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (SOAP Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

soapcontrol.SSLCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (SOAP Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

soapcontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (SOAP Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

soapcontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (SOAP Control)

The issuer of the certificate.

Syntax

soapcontrol.SSLCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (SOAP Control)

The private key of the certificate (if available).

Syntax

soapcontrol.SSLCertPrivateKey

Default Value

""

Remarks

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

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (SOAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

soapcontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (SOAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

soapcontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (SOAP Control)

The public key of the certificate.

Syntax

soapcontrol.SSLCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (SOAP Control)

The textual description of the certificate's public key algorithm.

Syntax

soapcontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (SOAP Control)

The length of the certificate's public key (in bits).

Syntax

soapcontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (SOAP Control)

The serial number of the certificate encoded as a string.

Syntax

soapcontrol.SSLCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (SOAP Control)

The text description of the certificate's signature algorithm.

Syntax

soapcontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertStore Property (SOAP Control)

The name of the certificate store for the client certificate.

Syntax

soapcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (SOAP Control)

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

Syntax

soapcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (SOAP Control)

The type of certificate store for this certificate.

Syntax

soapcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (SOAP Control)

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

Syntax

soapcontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (SOAP Control)

The MD5 hash of the certificate.

Syntax

soapcontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (SOAP Control)

The SHA-1 hash of the certificate.

Syntax

soapcontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (SOAP Control)

The SHA-256 hash of the certificate.

Syntax

soapcontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertUsage Property (SOAP Control)

The text description of UsageFlags .

Syntax

soapcontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (SOAP Control)

The flags that show intended use for the certificate.

Syntax

soapcontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (SOAP Control)

The certificate's version number.

Syntax

soapcontrol.SSLCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (SOAP Control)

The subject of the certificate used for client authentication.

Syntax

soapcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (SOAP Control)

The certificate (PEM/Base64 encoded).

Syntax

soapcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (SOAP Control)

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

Syntax

soapcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (SOAP Control)

The date on which this certificate becomes valid.

Syntax

soapcontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (SOAP Control)

The date on which the certificate expires.

Syntax

soapcontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (SOAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

soapcontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (SOAP Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

soapcontrol.SSLServerCertFingerprint

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (SOAP Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

soapcontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (SOAP Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

soapcontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (SOAP Control)

The issuer of the certificate.

Syntax

soapcontrol.SSLServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (SOAP Control)

The private key of the certificate (if available).

Syntax

soapcontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

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

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (SOAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

soapcontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (SOAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

soapcontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (SOAP Control)

The public key of the certificate.

Syntax

soapcontrol.SSLServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (SOAP Control)

The textual description of the certificate's public key algorithm.

Syntax

soapcontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (SOAP Control)

The length of the certificate's public key (in bits).

Syntax

soapcontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (SOAP Control)

The serial number of the certificate encoded as a string.

Syntax

soapcontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (SOAP Control)

The text description of the certificate's signature algorithm.

Syntax

soapcontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (SOAP Control)

The name of the certificate store for the client certificate.

Syntax

soapcontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (SOAP Control)

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

Syntax

soapcontrol.SSLServerCertStorePassword

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (SOAP Control)

The type of certificate store for this certificate.

Syntax

soapcontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (SOAP Control)

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

Syntax

soapcontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (SOAP Control)

The MD5 hash of the certificate.

Syntax

soapcontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (SOAP Control)

The SHA-1 hash of the certificate.

Syntax

soapcontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (SOAP Control)

The SHA-256 hash of the certificate.

Syntax

soapcontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (SOAP Control)

The text description of UsageFlags .

Syntax

soapcontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (SOAP Control)

The flags that show intended use for the certificate.

Syntax

soapcontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (SOAP Control)

The certificate's version number.

Syntax

soapcontrol.SSLServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (SOAP Control)

The subject of the certificate used for client authentication.

Syntax

soapcontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (SOAP Control)

The certificate (PEM/Base64 encoded).

Syntax

soapcontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

StatusLine Property (SOAP Control)

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

Syntax

soapcontrol.StatusLine

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 control, 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.

Data Type

String

Timeout Property (SOAP Control)

The timeout for the control.

Syntax

soapcontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (SOAP Control)

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

Syntax

soapcontrol.TransferredData

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .TransferredDataB.

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

Data Type

Binary String

TransferredDataLimit Property (SOAP Control)

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

Syntax

soapcontrol.TransferredDataLimit[=long64]

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

Data Type

Long64

TransferredHeaders Property (SOAP Control)

The full set of headers as received from the server.

Syntax

soapcontrol.TransferredHeaders

Default Value

""

Remarks

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

The Header event shows the individual headers as parsed by the control.

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

Data Type

String

URL Property (SOAP Control)

This property specifies the URL to retrieve.

Syntax

soapcontrol.URL[=string]

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.

Data Type

String

User Property (SOAP Control)

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

Syntax

soapcontrol.User[=string]

Default Value

""

Remarks

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

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the control will attempt to authenticate using the current user's credentials.

Data Type

String

ValueFormat Property (SOAP Control)

This property includes the format of data returned or set.

Syntax

soapcontrol.ValueFormat[=integer]

Possible Values

vfText(0), 
vfXML(1), 
vfFullXML(2)

Default Value

1

Remarks

The ValueFormat property specifies the format of the data set or received into/from value properties, such as XText, ReturnValue, and the Params properties.

The following are the possible values:

Data Type

Integer

AttrCount Property (SOAP Control)

The number of records in the Attr arrays.

Syntax

soapcontrol.AttrCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

The array indices start at 0 and end at AttrCount - 1.

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

Data Type

Integer

AttrName Property (SOAP Control)

The Name provides the local name (without prefix) of the attribute.

Syntax

soapcontrol.AttrName(AttrIndex)

Default Value

""

Remarks

The AttrName provides the local name (without prefix) of the attribute.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

AttrNamespace Property (SOAP Control)

This property contains the attribute namespace.

Syntax

soapcontrol.AttrNamespace(AttrIndex)

Default Value

""

Remarks

This property contains the attribute namespace.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

AttrPrefix Property (SOAP Control)

This property contains the attribute prefix (if any).

Syntax

soapcontrol.AttrPrefix(AttrIndex)

Default Value

""

Remarks

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

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

AttrValue Property (SOAP Control)

This property contains the attribute value.

Syntax

soapcontrol.AttrValue(AttrIndex)

Default Value

""

Remarks

This property contains the attribute value.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

XChildCount Property (SOAP Control)

The number of records in the XChild arrays.

Syntax

soapcontrol.XChildCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

The array indices start at 0 and end at XChildCount - 1.

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

Data Type

Integer

XChildName Property (SOAP Control)

The Name property provides the local name (without a prefix) of the element.

Syntax

soapcontrol.XChildName(XChildIndex)

Default Value

""

Remarks

The XChildName property provides the local name (without a prefix) of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XChildNamespace Property (SOAP Control)

This property contains the namespace of the element.

Syntax

soapcontrol.XChildNamespace(XChildIndex)

Default Value

""

Remarks

This property contains the namespace of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XChildPrefix Property (SOAP Control)

This property contains the prefix of the element (if any).

Syntax

soapcontrol.XChildPrefix(XChildIndex)

Default Value

""

Remarks

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

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XChildXText Property (SOAP Control)

This property contains the inner text of the element.

Syntax

soapcontrol.XChildXText(XChildIndex)

Default Value

""

Remarks

This property contains the inner text of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XElement Property (SOAP Control)

This property includes the name of the element pointed to by XPath .

Syntax

soapcontrol.XElement

Default Value

""

Remarks

The corresponding prefix is provided by XPrefix.

This property is read-only.

Data Type

String

XNamespace Property (SOAP Control)

This property includes the namespace of the element pointed to by XPath .

Syntax

soapcontrol.XNamespace

Default Value

""

Remarks

The corresponding namespace prefix is provided by XPrefix.

This property is read-only.

Data Type

String

XParent Property (SOAP Control)

This property includes the parent of the element pointed to by XPath .

Syntax

soapcontrol.XParent

Default Value

""

Remarks

If XPath points to the top element, XParent is an empty string.

This property is read-only.

Data Type

String

XPath Property (SOAP Control)

This property includes a path into the SOAPPacket received by the server.

Syntax

soapcontrol.XPath[=string]

Default Value

""

Remarks

The syntax is a subset of the XPath language.

Use this property to look at details of the SOAPPacket received by the server.

Data Type

String

XPrefix Property (SOAP Control)

This property includes the prefix of the element pointed to by XPath .

Syntax

soapcontrol.XPrefix

Default Value

""

Remarks

The corresponding element name is provided by XElement.

This property is read-only.

Data Type

String

XText Property (SOAP Control)

This property includes the text of the element pointed to by XPath .

Syntax

soapcontrol.XText

Default Value

""

Remarks

The ValueFormat property controls the format in which the value is returned.

This property is read-only.

Data Type

String

AddCookie Method (SOAP Control)

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

Syntax

soapcontrol.AddCookie CookieName, CookieValue

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddNamespace Method (SOAP Control)

This method adds a namespace to the Namespaces properties.

Syntax

soapcontrol.AddNamespace Prefix, NamespaceURI

Remarks

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

AddParam Method (SOAP Control)

This method adds a parameter-value pair.

Syntax

soapcontrol.AddParam ParamName, ParamValue

Remarks

Please refer to the parameter name and value provided in the Params properties for more information on SOAP parameters and how they are managed.

Example 1. Send SOAP Request:

SOAPControl.Reset() SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest() Example 3. Send SOAP Request Using Param Arrays: SOAPControl.Reset() SOAPControl.ParamCount = 2 SOAPControl.ParamName(0) = "paramname" SOAPControl.ParamValue(0) = "paramvalue" SOAPControl.ParamName(1) = "paramname2" SOAPControl.ParamValue(1) = "paramvalue2" SOAPControl.ParamAttrs(1) = "customattr=value" SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest()

Attr Method (SOAP Control)

This method returns the value of the specified attribute.

Syntax

soapcontrol.Attr AttrName

Remarks

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

Please refer to the XAttributes properties for more information.

BuildPacket Method (SOAP Control)

This method builds the request packet.

Syntax

soapcontrol.BuildPacket 

Remarks

The resulting packet is placed in SOAPPacket.

Config Method (SOAP Control)

Sets or retrieves a configuration setting.

Syntax

soapcontrol.Config ConfigurationString

Remarks

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

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

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

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (SOAP Control)

This method processes events from the internal message queue.

Syntax

soapcontrol.DoEvents 

Remarks

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

EvalPacket Method (SOAP Control)

This method evaluates the packet in SOAPPacket .

Syntax

soapcontrol.EvalPacket 

Remarks

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

HasXPath Method (SOAP Control)

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

Syntax

soapcontrol.HasXPath XPath

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.

This method returns True if the xpath exists, and False if not.

See XPath for details on the XPath syntax.

Interrupt Method (SOAP Control)

This method interrupts the current method.

Syntax

soapcontrol.Interrupt 

Remarks

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

Reset Method (SOAP Control)

This method resets the control.

Syntax

soapcontrol.Reset 

Remarks

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

SendPacket Method (SOAP Control)

This method sends the packet.

Syntax

soapcontrol.SendPacket 

Remarks

This method may also be used to send a packet placed in SOAPPacket.

Example. Send SOAP Request:

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

This method sends the request.

Syntax

soapcontrol.SendRequest 

Remarks

Calling this method is equivalent to calling BuildPacket, SendPacket, and EvalPacket in succession.

Example. Send SOAP Request:

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

TryXPath Method (SOAP Control)

This method navigates to the specified XPath if it exists.

Syntax

soapcontrol.TryXPath xpath

Remarks

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

If the XPath exists, the XPath property will be updated and this method returns True.

If the XPath does not exist, the XPath property is not updated and this method returns False.

Value Method (SOAP Control)

This method returns the value of a parameter.

Syntax

soapcontrol.Value ParamName

Remarks

The control will search through the Params properties for the parameter identified by ParamName and will return the value associated with it provided in the properties.

Connected Event (SOAP Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub soapcontrol_Connected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SOAP Control)

Fired to indicate changes in the connection state.

Syntax

Sub soapcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

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:

Disconnected Event (SOAP Control)

Fired when a connection is closed.

Syntax

Sub soapcontrol_Disconnected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

EndTransfer Event (SOAP Control)

This event is fired when a document finishes transferring.

Syntax

Sub soapcontrol_EndTransfer(Direction As Integer)

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

Fired when information is available about errors during data delivery.

Syntax

Sub soapcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (SOAP Control)

Fired every time a header line comes in.

Syntax

Sub soapcontrol_Header(Field As String, Value As String)

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

Fired once for each log message.

Syntax

Sub soapcontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

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

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

Fired when a redirection is received from the server.

Syntax

Sub soapcontrol_Redirect(Location As String, Accept As Boolean)

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 control fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (SOAP Control)

Fired for every cookie set by the server.

Syntax

Sub soapcontrol_SetCookie(Name As String, Value As String, Expires As String, Domain As String, Path As String, Secure As Boolean)

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

Fired after the server presents its certificate to the client.

Syntax

Sub soapcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (SOAP Control)

Fired when secure connection progress messages are available.

Syntax

Sub soapcontrol_SSLStatus(Message As String)

Remarks

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

StartTransfer Event (SOAP Control)

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

Syntax

Sub soapcontrol_StartTransfer(Direction As Integer)

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

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

Syntax

Sub soapcontrol_Status(HTTPVersion As String, StatusCode As Integer, Description As String)

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

This event is fired while the response transfers.

Syntax

Sub soapcontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer)

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.

Config Settings (SOAP Control)

SOAP Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

Trappable Errors (SOAP Control)

SOAP Errors

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

SSLClient Errors

SSL Errors

TCP/IP Errors

XML Errors