SOAPClient Class

Properties   Methods   Events   Config Settings   Errors  

The SOAPClient class sends SOAP messages.

Syntax

SOAPClient

Remarks

The SOAPClient class implements client-side functionality of the SOAP version 1.1 and 1.2 protocols over HTTP/HTTPS.

Property List


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

AttachmentBytesUse this property to pass an attachment to class in the byte array form.
AttachmentFileSpecifies the attachment file to be sent with the request.
BlockedCertCountThe number of records in the BlockedCert arrays.
BlockedCertBytesReturns raw certificate data in DER format.
BlockedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ClientCertCountThe number of records in the ClientCert arrays.
ClientCertBytesReturns raw certificate data in DER format.
ClientCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ConnInfoAEADCipherIndicates whether the encryption algorithm used is an AEAD cipher.
ConnInfoChainValidationDetailsThe details of a certificate chain validation outcome.
ConnInfoChainValidationResultThe outcome of a certificate chain validation routine.
ConnInfoCiphersuiteThe cipher suite employed by this connection.
ConnInfoClientAuthenticatedSpecifies whether client authentication was performed during this connection.
ConnInfoClientAuthRequestedSpecifies whether client authentication was requested during this connection.
ConnInfoConnectionEstablishedIndicates whether the connection has been established fully.
ConnInfoConnectionIDThe unique identifier assigned to this connection.
ConnInfoDigestAlgorithmThe digest algorithm used in a TLS-enabled connection.
ConnInfoEncryptionAlgorithmThe symmetric encryption algorithm used in a TLS-enabled connection.
ConnInfoExportableIndicates whether a TLS connection uses a reduced-strength exportable cipher.
ConnInfoKeyExchangeAlgorithmThe key exchange algorithm used in a TLS-enabled connection.
ConnInfoKeyExchangeKeyBitsThe length of the key exchange key of a TLS-enabled connection.
ConnInfoNamedECCurveThe elliptic curve used in this connection.
ConnInfoPFSCipherIndicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
ConnInfoPreSharedIdentityHintA hint professed by the server to help the client select the PSK identity to use.
ConnInfoPublicKeyBitsThe length of the public key.
ConnInfoResumedSessionIndicates whether a TLS-enabled connection was spawned from another TLS connection.
ConnInfoSecureConnectionIndicates whether TLS or SSL is enabled for this connection.
ConnInfoServerAuthenticatedIndicates whether server authentication was performed during a TLS-enabled connection.
ConnInfoSignatureAlgorithmThe signature algorithm used in a TLS handshake.
ConnInfoSymmetricBlockSizeThe block size of the symmetric algorithm used.
ConnInfoSymmetricKeyBitsThe key length of the symmetric algorithm used.
ConnInfoTotalBytesReceivedThe total number of bytes received over this connection.
ConnInfoTotalBytesSentThe total number of bytes sent over this connection.
ConnInfoValidationLogContains the server certificate's chain validation log.
ConnInfoVersionIndicates the version of SSL/TLS protocol negotiated during this connection.
EncodingSpecifies SOAP message encoding.
ExternalCryptoAsyncDocumentIDSpecifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
ExternalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
ExternalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecretThe pre-shared key used for DC request authentication.
ExternalCryptoMethodSpecifies the asynchronous signing method.
ExternalCryptoModeSpecifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
FaultActorSpecifies the entity that caused the fault.
FaultCodeSpecifies the error code.
FaultDetailContains application-specific error information.
FaultStringSpecifies a human-readable description of the fault.
FIPSModeReserved.
InputBytesUse this property to pass the input to class in the byte array form.
InputFileA path to the file containing the SOAP message to be sent.
KeepAlivePolicyDefines the keep-alive handling policy.
KnownCertCountThe number of records in the KnownCert arrays.
KnownCertBytesReturns raw certificate data in DER format.
KnownCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCountThe number of records in the KnownCRL arrays.
KnownCRLBytesReturns raw CRL data in DER format.
KnownCRLHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCountThe number of records in the KnownOCSP arrays.
KnownOCSPBytesBuffer containing raw OCSP response data.
KnownOCSPHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
MimeTypeSpecifies the SOAP message MIME type.
OperationNameSpecifies the SOAP operation name.
OperationNamespaceURISpecifies the SOAP message operation namespace URI.
OperationResponseNameSpecifies the operation name of the response message.
OperationResponseNamespaceURISpecifies the response SOAP message operation namespace URI.
OperationResponseTextContentReturns the text content of the response message.
OperationResponseXMLReturns the XML content of the response SOAP message.
OutputAttachmentBytesUse this property to read the attachment received from the service.
OutputAttachmentFileA path to a file where to save the attachment data.
OutputBytesUse this property to read the output the class object has produced.
OutputFileA file where the response will be saved.
ProxyAddressThe IP address of the proxy server.
ProxyAuthenticationThe authentication type used by the proxy server.
ProxyPasswordThe password to authenticate to the proxy server.
ProxyPortThe port on the proxy server to connect to.
ProxyProxyTypeThe type of the proxy server.
ProxyRequestHeadersContains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeadersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUseProxyEnables or disables proxy-driven connection.
ProxyUsernameSpecifies the username credential for proxy authentication.
ReasonPhraseContains the Reason Phrase element of the server's response.
ReqHeaderCountThe number of records in the ReqHeader arrays.
ReqHeaderCategorySpecifies the string category of the contained value.
ReqHeaderFormatSpecifies the format (encoding) of the value contained in the Value property.
ReqHeaderNameThe name element in a (name, value) pair.
ReqHeaderValueThe value element in a (name, value) pair.
ReqParamsAcceptSpecifies the Accept header property of the HTTP request.
ReqParamsAcceptCharsetSpecifies the Accept-Charset header property of the HTTP request.
ReqParamsAcceptLanguageSpecifies the Accept-Language header property of the HTTP request.
ReqParamsAcceptRangeEndThis property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.
ReqParamsAcceptRangeStartThis property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.
ReqParamsAuthorizationSpecifies the Authorization header of the HTTP request.
ReqParamsConnectionSpecifies the value to pass to the Connection header property of HTTP request.
ReqParamsContentLengthSpecifies the size of the entity-body of the HTTP request.
ReqParamsContentRangeEndSpecifies the upper bound used in the Content-Range header of the HTTP request.
ReqParamsContentRangeFullSizeSpecifies the total length of the full entity-body of the HTTP request.
ReqParamsContentRangeStartSpecifies the lower bound used in the Content-Range header of the HTTP request.
ReqParamsContentTypeThe Content-Type header property of the HTTP request.
ReqParamsCookieThis header is expected to be assigned with cookies previously received from the server and stored by the client.
ReqParamsCustomHeadersAssign any custom HTTP headers to be passed to the server to this property.
ReqParamsDateThe date and time of the request.
ReqParamsFromContains the From header property of the HTTP request.
ReqParamsHostThis property contains the Host header property of the HTTP request.
ReqParamsHTTPVersionSpecifies the version of HTTP protocol to use: 1.
ReqParamsIfMatchContains the If-Match request header property.
ReqParamsIfModifiedSinceContains the If-Modified-Since request header property.
ReqParamsIfNoneMatchContains the If-None-Match request header property.
ReqParamsIfUnmodifiedSinceContains the If-Unmodified-Since request header property.
ReqParamsPasswordAssign this property with the user's password.
ReqParamsRefererThe Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).
ReqParamsUserAgentThe User-Agent property of the HTTP request provides information about the software that initiates the request.
ReqParamsUsernameAssign this property with the user's login name.
RespHeaderCountThe number of records in the RespHeader arrays.
RespHeaderCategorySpecifies the string category of the contained value.
RespHeaderFormatSpecifies the format (encoding) of the value contained in the Value property.
RespHeaderNameThe name element in a (name, value) pair.
RespHeaderValueThe value element in a (name, value) pair.
RespParamsContentLengthIndicates the length of the response content in bytes.
RespParamsDateThe date and time at which the response was generated, in server time, in UTC.
RespParamsReasonPhraseContains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.
RespParamsStatusCodeThe server-generated status code of the request processing status.
ServerCertCountThe number of records in the ServerCert arrays.
ServerCertBytesReturns raw certificate data in DER format.
ServerCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
ServerCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
ServerCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ServerCertIssuerThe common name of the certificate issuer (CA), typically a company name.
ServerCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
ServerCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
ServerCertKeyBitsReturns the length of the public key.
ServerCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
ServerCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
ServerCertPublicKeyBytesContains the certificate's public key in DER format.
ServerCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
ServerCertSerialNumberReturns the certificate's serial number.
ServerCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
ServerCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
ServerCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
ServerCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
ServerCertValidFromThe time point at which the certificate becomes valid, in UTC.
ServerCertValidToThe time point at which the certificate expires, in UTC.
SOAPActionSpecifies the SOAP action.
SOAPResponseTypeThe type of the response.
SOAPVersionSpecifies SOAP version.
SocketDNSModeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPortSpecifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeoutThe timeout (in milliseconds) for each DNS query.
SocketDNSServersThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeoutThe timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimitThe maximum number of bytes to read from the socket, per second.
SocketLocalAddressThe local network interface to bind the socket to.
SocketLocalPortThe local port number to bind the socket to.
SocketOutgoingSpeedLimitThe maximum number of bytes to write to the socket, per second.
SocketTimeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6Enables or disables IP protocol version 6.
StatusCodeContains the Status Code element of the server's response.
TLSAutoValidateCertificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfigurationSelects the base configuration for the TLS settings.
TLSCiphersuitesA list of ciphersuites separated with commas or semicolons.
TLSECCurvesDefines the elliptic curves to enable.
TLSExtensionsProvides access to TLS extensions.
TLSForceResumeIfDestinationChangesWhether to force TLS session resumption when the destination address changes.
TLSPreSharedIdentityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKeyContains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionModeSelects renegotiation attack prevention mechanism.
TLSRevocationCheckSpecifies the kind(s) of revocation check to perform.
TLSSSLOptionsVarious SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
TLSTLSModeSpecifies the TLS mode to use.
TLSUseExtendedMasterSecretEnables Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumptionEnables or disables TLS session resumption capability.
TLSVersionsThe SSL/TLS versions to enable by default.
TrustedCertCountThe number of records in the TrustedCert arrays.
TrustedCertBytesReturns raw certificate data in DER format.
TrustedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UseDigestAuthEnables or disables the HTTP Digest authentication.
UseKerberosAuthEnables Kerberos authentication mechanism.
UseNTLMAuthEnables or disables NTLM authentication.

Method List


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

ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
SendMessageSends a SOAP message to the server.
SendMessageWithAttachmentsSends a SOAP message with attachment(s) to the server.

Event List


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

BeforeReceiveAttachmentMarks the start of receiving an attachment.
BeforeSendAttachmentMarks the start of sending an attachment.
CookieFired to report a received cookie.
DocumentBeginMarks the start of the incoming HTML document or file.
DocumentEndMarks the successful receipt of the incoming HTML document or file.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
HeadersPreparedFires when the request headers have been formed and are about to be sent to the server.
HeadersReceivedFires when the HTTP response headers have just been received from the server.
NotificationThis event notifies the application about an underlying control flow event.
ProgressFires periodically during the data transfer.
RedirectionFires when the server suggests a redirect.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSPSKNotifies the application about the PSK key exchange.
TLSShutdownReports the graceful closure of a TLS connection.

Config Settings


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

AttachmentContentDescriptionSpecifies attachment content description.
AttachmentContentIdSpecifies attachment content Id.
AttachmentContentTypeSpecifies attachment content type.
AttachmentFilenameSpecifies attachment filename.
CacheStreamOutputTells the class whether to cache stream- and file-bound responses in the class.
FaultActor[Index]Specifies who caused the fault.
FaultCode[Index]Specifies the error code.
FaultCountThe number of faults.
FaultDetail[Index]Contains application-specific error information.
FaultString[Index]Specifies a human-readable description of fault.
FaultXML[Index]Specifies the XML content of the fault.
ForceNTLMAuthActivates and enforces NTLM authentication.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
IgnoreUnknownTransferEncodingsAll incoming responses with unknown transfer encodings are ignored if this property is true.
MaxRedirectionsThe maximum number of HTTP redirects.
PersistentAuthHeaderWhether to resend NTLM negotiation on every request.
RelatedStartInfoSpecifies Start-Info parameter.
RelatedTypeSpecifies media type/subtype.
RequestCompressionGZipAsk server to use GZip compression.
RequestCompressionLevelAsk server to use the specified compression level.
SendBufferSizeSize of send buffer in bytes.
SkipInputProcessingWhether to skip input processing.
SkipOutputParsingWhether to skip output parsing.
SOAPPrefixSpecifies the signature prefix.
SuppressRedirectionContentWhether to suppress the redirection content.
TempPathPath for storing temporary files.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
Use100ContinueWhether to use 100-continue for POST and PUT commands.
UseCompressionWhether to use GZip compression.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSOAPActionWhether to use SOAP Action.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AttachmentBytes Property (SOAPClient Class)

Use this property to pass an attachment to class in the byte array form.

Syntax

ANSI (Cross Platform)
int GetAttachmentBytes(char* &lpAttachmentBytes, int &lenAttachmentBytes);
int SetAttachmentBytes(const char* lpAttachmentBytes, int lenAttachmentBytes); Unicode (Windows) INT GetAttachmentBytes(LPSTR &lpAttachmentBytes, INT &lenAttachmentBytes);
INT SetAttachmentBytes(LPCSTR lpAttachmentBytes, INT lenAttachmentBytes);
int secureblackbox_soapclient_getattachmentbytes(void* lpObj, char** lpAttachmentBytes, int* lenAttachmentBytes);
int secureblackbox_soapclient_setattachmentbytes(void* lpObj, const char* lpAttachmentBytes, int lenAttachmentBytes);
QByteArray GetAttachmentBytes();
int SetAttachmentBytes(QByteArray qbaAttachmentBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

AttachmentFile Property (SOAPClient Class)

Specifies the attachment file to be sent with the request.

Syntax

ANSI (Cross Platform)
char* GetAttachmentFile();
int SetAttachmentFile(const char* lpszAttachmentFile); Unicode (Windows) LPWSTR GetAttachmentFile();
INT SetAttachmentFile(LPCWSTR lpszAttachmentFile);
char* secureblackbox_soapclient_getattachmentfile(void* lpObj);
int secureblackbox_soapclient_setattachmentfile(void* lpObj, const char* lpszAttachmentFile);
QString GetAttachmentFile();
int SetAttachmentFile(QString qsAttachmentFile);

Default Value

""

Remarks

Provide a full path to the attachment file to be sent with the SOAP request. Use SendMessageWithAttachments method to send the request.

Subscribe to BeforeSendAttachment to pass more than one attachment.

Data Type

String

BlockedCertCount Property (SOAPClient Class)

The number of records in the BlockedCert arrays.

Syntax

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); Unicode (Windows) INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);
int secureblackbox_soapclient_getblockedcertcount(void* lpObj);
int secureblackbox_soapclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SOAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes);

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);
int secureblackbox_soapclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

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

Data Type

Byte Array

BlockedCertHandle Property (SOAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle); Unicode (Windows) LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);
int64 secureblackbox_soapclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_soapclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is not available at design time.

Data Type

Long64

ClientCertCount Property (SOAPClient Class)

The number of records in the ClientCert arrays.

Syntax

ANSI (Cross Platform)
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount); Unicode (Windows) INT GetClientCertCount();
INT SetClientCertCount(INT iClientCertCount);
int secureblackbox_soapclient_getclientcertcount(void* lpObj);
int secureblackbox_soapclient_setclientcertcount(void* lpObj, int iClientCertCount);
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (SOAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetClientCertBytes(int iClientCertIndex, char* &lpClientCertBytes, int &lenClientCertBytes);

Unicode (Windows)
INT GetClientCertBytes(INT iClientCertIndex, LPSTR &lpClientCertBytes, INT &lenClientCertBytes);
int secureblackbox_soapclient_getclientcertbytes(void* lpObj, int clientcertindex, char** lpClientCertBytes, int* lenClientCertBytes);
QByteArray GetClientCertBytes(int iClientCertIndex);

Remarks

Returns raw certificate data in DER format.

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

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

Data Type

Byte Array

ClientCertHandle Property (SOAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, int64 lClientCertHandle); Unicode (Windows) LONG64 GetClientCertHandle(INT iClientCertIndex);
INT SetClientCertHandle(INT iClientCertIndex, LONG64 lClientCertHandle);
int64 secureblackbox_soapclient_getclientcerthandle(void* lpObj, int clientcertindex);
int secureblackbox_soapclient_setclientcerthandle(void* lpObj, int clientcertindex, int64 lClientCertHandle);
qint64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, qint64 lClientCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is not available at design time.

Data Type

Long64

ConnInfoAEADCipher Property (SOAPClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

ANSI (Cross Platform)
int GetConnInfoAEADCipher();

Unicode (Windows)
BOOL GetConnInfoAEADCipher();
int secureblackbox_soapclient_getconninfoaeadcipher(void* lpObj);
bool GetConnInfoAEADCipher();

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

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

Data Type

Boolean

ConnInfoChainValidationDetails Property (SOAPClient Class)

The details of a certificate chain validation outcome.

Syntax

ANSI (Cross Platform)
int GetConnInfoChainValidationDetails();

Unicode (Windows)
INT GetConnInfoChainValidationDetails();
int secureblackbox_soapclient_getconninfochainvalidationdetails(void* lpObj);
int GetConnInfoChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

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

Data Type

Integer

ConnInfoChainValidationResult Property (SOAPClient Class)

The outcome of a certificate chain validation routine.

Syntax

ANSI (Cross Platform)
int GetConnInfoChainValidationResult();

Unicode (Windows)
INT GetConnInfoChainValidationResult();

Possible Values

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_soapclient_getconninfochainvalidationresult(void* lpObj);
int GetConnInfoChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

ConnInfoCiphersuite Property (SOAPClient Class)

The cipher suite employed by this connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoCiphersuite();

Unicode (Windows)
LPWSTR GetConnInfoCiphersuite();
char* secureblackbox_soapclient_getconninfociphersuite(void* lpObj);
QString GetConnInfoCiphersuite();

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

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

Data Type

String

ConnInfoClientAuthenticated Property (SOAPClient Class)

Specifies whether client authentication was performed during this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoClientAuthenticated();

Unicode (Windows)
BOOL GetConnInfoClientAuthenticated();
int secureblackbox_soapclient_getconninfoclientauthenticated(void* lpObj);
bool GetConnInfoClientAuthenticated();

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

ConnInfoClientAuthRequested Property (SOAPClient Class)

Specifies whether client authentication was requested during this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoClientAuthRequested();

Unicode (Windows)
BOOL GetConnInfoClientAuthRequested();
int secureblackbox_soapclient_getconninfoclientauthrequested(void* lpObj);
bool GetConnInfoClientAuthRequested();

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

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

Data Type

Boolean

ConnInfoConnectionEstablished Property (SOAPClient Class)

Indicates whether the connection has been established fully.

Syntax

ANSI (Cross Platform)
int GetConnInfoConnectionEstablished();

Unicode (Windows)
BOOL GetConnInfoConnectionEstablished();
int secureblackbox_soapclient_getconninfoconnectionestablished(void* lpObj);
bool GetConnInfoConnectionEstablished();

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

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

Data Type

Boolean

ConnInfoConnectionID Property (SOAPClient Class)

The unique identifier assigned to this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoConnectionID(char* &lpConnInfoConnectionID, int &lenConnInfoConnectionID);

Unicode (Windows)
INT GetConnInfoConnectionID(LPSTR &lpConnInfoConnectionID, INT &lenConnInfoConnectionID);
int secureblackbox_soapclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);
QByteArray GetConnInfoConnectionID();

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

ConnInfoDigestAlgorithm Property (SOAPClient Class)

The digest algorithm used in a TLS-enabled connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoDigestAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoDigestAlgorithm();
char* secureblackbox_soapclient_getconninfodigestalgorithm(void* lpObj);
QString GetConnInfoDigestAlgorithm();

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

ConnInfoEncryptionAlgorithm Property (SOAPClient Class)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithm();
char* secureblackbox_soapclient_getconninfoencryptionalgorithm(void* lpObj);
QString GetConnInfoEncryptionAlgorithm();

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

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

Data Type

String

ConnInfoExportable Property (SOAPClient Class)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

ANSI (Cross Platform)
int GetConnInfoExportable();

Unicode (Windows)
BOOL GetConnInfoExportable();
int secureblackbox_soapclient_getconninfoexportable(void* lpObj);
bool GetConnInfoExportable();

Default Value

FALSE

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

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

Data Type

Boolean

ConnInfoKeyExchangeAlgorithm Property (SOAPClient Class)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKeyExchangeAlgorithm();
char* secureblackbox_soapclient_getconninfokeyexchangealgorithm(void* lpObj);
QString GetConnInfoKeyExchangeAlgorithm();

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

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

Data Type

String

ConnInfoKeyExchangeKeyBits Property (SOAPClient Class)

The length of the key exchange key of a TLS-enabled connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoKeyExchangeKeyBits();

Unicode (Windows)
INT GetConnInfoKeyExchangeKeyBits();
int secureblackbox_soapclient_getconninfokeyexchangekeybits(void* lpObj);
int GetConnInfoKeyExchangeKeyBits();

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

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

Data Type

Integer

ConnInfoNamedECCurve Property (SOAPClient Class)

The elliptic curve used in this connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoNamedECCurve();

Unicode (Windows)
LPWSTR GetConnInfoNamedECCurve();
char* secureblackbox_soapclient_getconninfonamedeccurve(void* lpObj);
QString GetConnInfoNamedECCurve();

Default Value

""

Remarks

The elliptic curve used in this connection.

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

Data Type

String

ConnInfoPFSCipher Property (SOAPClient Class)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

ANSI (Cross Platform)
int GetConnInfoPFSCipher();

Unicode (Windows)
BOOL GetConnInfoPFSCipher();
int secureblackbox_soapclient_getconninfopfscipher(void* lpObj);
bool GetConnInfoPFSCipher();

Default Value

FALSE

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

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

Data Type

Boolean

ConnInfoPreSharedIdentityHint Property (SOAPClient Class)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

ANSI (Cross Platform)
char* GetConnInfoPreSharedIdentityHint();

Unicode (Windows)
LPWSTR GetConnInfoPreSharedIdentityHint();
char* secureblackbox_soapclient_getconninfopresharedidentityhint(void* lpObj);
QString GetConnInfoPreSharedIdentityHint();

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

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

Data Type

String

ConnInfoPublicKeyBits Property (SOAPClient Class)

The length of the public key.

Syntax

ANSI (Cross Platform)
int GetConnInfoPublicKeyBits();

Unicode (Windows)
INT GetConnInfoPublicKeyBits();
int secureblackbox_soapclient_getconninfopublickeybits(void* lpObj);
int GetConnInfoPublicKeyBits();

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

ConnInfoResumedSession Property (SOAPClient Class)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoResumedSession();

Unicode (Windows)
BOOL GetConnInfoResumedSession();
int secureblackbox_soapclient_getconninforesumedsession(void* lpObj);
bool GetConnInfoResumedSession();

Default Value

FALSE

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

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

Data Type

Boolean

ConnInfoSecureConnection Property (SOAPClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoSecureConnection();

Unicode (Windows)
BOOL GetConnInfoSecureConnection();
int secureblackbox_soapclient_getconninfosecureconnection(void* lpObj);
bool GetConnInfoSecureConnection();

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

ConnInfoServerAuthenticated Property (SOAPClient Class)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoServerAuthenticated();

Unicode (Windows)
BOOL GetConnInfoServerAuthenticated();
int secureblackbox_soapclient_getconninfoserverauthenticated(void* lpObj);
bool GetConnInfoServerAuthenticated();

Default Value

FALSE

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

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

Data Type

Boolean

ConnInfoSignatureAlgorithm Property (SOAPClient Class)

The signature algorithm used in a TLS handshake.

Syntax

ANSI (Cross Platform)
char* GetConnInfoSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoSignatureAlgorithm();
char* secureblackbox_soapclient_getconninfosignaturealgorithm(void* lpObj);
QString GetConnInfoSignatureAlgorithm();

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

ConnInfoSymmetricBlockSize Property (SOAPClient Class)

The block size of the symmetric algorithm used.

Syntax

ANSI (Cross Platform)
int GetConnInfoSymmetricBlockSize();

Unicode (Windows)
INT GetConnInfoSymmetricBlockSize();
int secureblackbox_soapclient_getconninfosymmetricblocksize(void* lpObj);
int GetConnInfoSymmetricBlockSize();

Default Value

0

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoSymmetricKeyBits Property (SOAPClient Class)

The key length of the symmetric algorithm used.

Syntax

ANSI (Cross Platform)
int GetConnInfoSymmetricKeyBits();

Unicode (Windows)
INT GetConnInfoSymmetricKeyBits();
int secureblackbox_soapclient_getconninfosymmetrickeybits(void* lpObj);
int GetConnInfoSymmetricKeyBits();

Default Value

0

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoTotalBytesReceived Property (SOAPClient Class)

The total number of bytes received over this connection.

Syntax

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();
int64 secureblackbox_soapclient_getconninfototalbytesreceived(void* lpObj);
qint64 GetConnInfoTotalBytesReceived();

Default Value

0

Remarks

The total number of bytes received over this connection.

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

Data Type

Long64

ConnInfoTotalBytesSent Property (SOAPClient Class)

The total number of bytes sent over this connection.

Syntax

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();
int64 secureblackbox_soapclient_getconninfototalbytessent(void* lpObj);
qint64 GetConnInfoTotalBytesSent();

Default Value

0

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

ConnInfoValidationLog Property (SOAPClient Class)

Contains the server certificate's chain validation log.

Syntax

ANSI (Cross Platform)
char* GetConnInfoValidationLog();

Unicode (Windows)
LPWSTR GetConnInfoValidationLog();
char* secureblackbox_soapclient_getconninfovalidationlog(void* lpObj);
QString GetConnInfoValidationLog();

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

Data Type

String

ConnInfoVersion Property (SOAPClient Class)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoVersion();

Unicode (Windows)
LPWSTR GetConnInfoVersion();
char* secureblackbox_soapclient_getconninfoversion(void* lpObj);
QString GetConnInfoVersion();

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

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

Data Type

String

Encoding Property (SOAPClient Class)

Specifies SOAP message encoding.

Syntax

ANSI (Cross Platform)
char* GetEncoding();
int SetEncoding(const char* lpszEncoding); Unicode (Windows) LPWSTR GetEncoding();
INT SetEncoding(LPCWSTR lpszEncoding);
char* secureblackbox_soapclient_getencoding(void* lpObj);
int secureblackbox_soapclient_setencoding(void* lpObj, const char* lpszEncoding);
QString GetEncoding();
int SetEncoding(QString qsEncoding);

Default Value

""

Remarks

Use this property to specify the encoding to apply to the SOAP message.

Data Type

String

ExternalCryptoAsyncDocumentID Property (SOAPClient Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID); Unicode (Windows) LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_soapclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_soapclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SOAPClient Class)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams); Unicode (Windows) LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);
char* secureblackbox_soapclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_soapclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SOAPClient Class)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData); Unicode (Windows) LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);
char* secureblackbox_soapclient_getexternalcryptodata(void* lpObj);
int secureblackbox_soapclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SOAPClient Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation); Unicode (Windows) BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);
int secureblackbox_soapclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_soapclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SOAPClient Class)

Specifies the request's signature hash algorithm.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm); Unicode (Windows) LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);
char* secureblackbox_soapclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_soapclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

Data Type

String

ExternalCryptoKeyID Property (SOAPClient Class)

The ID of the pre-shared key used for DC request authentication.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID); Unicode (Windows) LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);
char* secureblackbox_soapclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_soapclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SOAPClient Class)

The pre-shared key used for DC request authentication.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret); Unicode (Windows) LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);
char* secureblackbox_soapclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_soapclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SOAPClient Class)

Specifies the asynchronous signing method.

Syntax

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); Unicode (Windows) INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

Possible Values

ASMD_PKCS1(0), 
ASMD_PKCS7(1)
int secureblackbox_soapclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_soapclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

Data Type

Integer

ExternalCryptoMode Property (SOAPClient Class)

Specifies the external cryptography mode.

Syntax

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); Unicode (Windows) INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

Possible Values

ECM_DEFAULT(0), 
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
int secureblackbox_soapclient_getexternalcryptomode(void* lpObj);
int secureblackbox_soapclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SOAPClient Class)

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm); Unicode (Windows) LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);
char* secureblackbox_soapclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_soapclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

""

Remarks

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Data Type

String

FaultActor Property (SOAPClient Class)

Specifies the entity that caused the fault.

Syntax

ANSI (Cross Platform)
char* GetFaultActor();

Unicode (Windows)
LPWSTR GetFaultActor();
char* secureblackbox_soapclient_getfaultactor(void* lpObj);
QString GetFaultActor();

Default Value

""

Remarks

Use this property to get the URI associated with the actor (SOAP node) that caused the fault. In RPC-style messaging, the actor is the URI of the Web service.

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

Data Type

String

FaultCode Property (SOAPClient Class)

Specifies the error code.

Syntax

ANSI (Cross Platform)
char* GetFaultCode();

Unicode (Windows)
LPWSTR GetFaultCode();
char* secureblackbox_soapclient_getfaultcode(void* lpObj);
QString GetFaultCode();

Default Value

""

Remarks

Use this property to get the standard code that provides more information about the fault. A set of code values is predefined by the SOAP specification. This set of fault code values can be extended by the application.

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

Data Type

String

FaultDetail Property (SOAPClient Class)

Contains application-specific error information.

Syntax

ANSI (Cross Platform)
char* GetFaultDetail();

Unicode (Windows)
LPWSTR GetFaultDetail();
char* secureblackbox_soapclient_getfaultdetail(void* lpObj);
QString GetFaultDetail();

Default Value

""

Remarks

Use this property to get the application-specific information, such as the exception that was thrown. This element can be an XML structure or plain text.

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

Data Type

String

FaultString Property (SOAPClient Class)

Specifies a human-readable description of the fault.

Syntax

ANSI (Cross Platform)
char* GetFaultString();

Unicode (Windows)
LPWSTR GetFaultString();
char* secureblackbox_soapclient_getfaultstring(void* lpObj);
QString GetFaultString();

Default Value

""

Remarks

Use this property to get the human-readable description of the error that happened.

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

Data Type

String

FIPSMode Property (SOAPClient Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_soapclient_getfipsmode(void* lpObj);
int secureblackbox_soapclient_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SOAPClient Class)

Use this property to pass the input to class in the byte array form.

Syntax

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes); Unicode (Windows) INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);
int secureblackbox_soapclient_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_soapclient_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);
QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (SOAPClient Class)

A path to the file containing the SOAP message to be sent.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_soapclient_getinputfile(void* lpObj);
int secureblackbox_soapclient_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

Use this property to provide a full path to the file containing the SOAP message to be sent to the server.

Data Type

String

KeepAlivePolicy Property (SOAPClient Class)

Defines the keep-alive handling policy.

Syntax

ANSI (Cross Platform)
int GetKeepAlivePolicy();
int SetKeepAlivePolicy(int iKeepAlivePolicy); Unicode (Windows) INT GetKeepAlivePolicy();
INT SetKeepAlivePolicy(INT iKeepAlivePolicy);

Possible Values

CKAP_STANDARD_DEFINED(0), 
CKAP_PREFER_KEEP_ALIVE(1),
CKAP_RELY_ON_SERVER(2),
CKAP_KEEP_ALIVES_DISABLED(3)
int secureblackbox_soapclient_getkeepalivepolicy(void* lpObj);
int secureblackbox_soapclient_setkeepalivepolicy(void* lpObj, int iKeepAlivePolicy);
int GetKeepAlivePolicy();
int SetKeepAlivePolicy(int iKeepAlivePolicy);

Default Value

0

Remarks

Use this property to tune-up the keep-alive mechanism as per the needs of your application.

ckapStandardDefined0Follow the standard
ckapPreferKeepAlive1Always request a keep-alive connection
ckapRelyOnServer2Not include the "Connection" header, allowing the server to choose the keep-alive mode
ckapKeepAlivesDisabled3Disable keep-alives by including the "Connection: Close" header

Data Type

Integer

KnownCertCount Property (SOAPClient Class)

The number of records in the KnownCert arrays.

Syntax

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); Unicode (Windows) INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);
int secureblackbox_soapclient_getknowncertcount(void* lpObj);
int secureblackbox_soapclient_setknowncertcount(void* lpObj, int iKnownCertCount);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SOAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);
int secureblackbox_soapclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

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

Data Type

Byte Array

KnownCertHandle Property (SOAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle); Unicode (Windows) LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);
int64 secureblackbox_soapclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_soapclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (SOAPClient Class)

The number of records in the KnownCRL arrays.

Syntax

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); Unicode (Windows) INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);
int secureblackbox_soapclient_getknowncrlcount(void* lpObj);
int secureblackbox_soapclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SOAPClient Class)

Returns raw CRL data in DER format.

Syntax

ANSI (Cross Platform)
int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes);

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);
int secureblackbox_soapclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

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

Data Type

Byte Array

KnownCRLHandle Property (SOAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle); Unicode (Windows) LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);
int64 secureblackbox_soapclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_soapclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (SOAPClient Class)

The number of records in the KnownOCSP arrays.

Syntax

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); Unicode (Windows) INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);
int secureblackbox_soapclient_getknownocspcount(void* lpObj);
int secureblackbox_soapclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SOAPClient Class)

Buffer containing raw OCSP response data.

Syntax

ANSI (Cross Platform)
int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes);

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);
int secureblackbox_soapclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

Buffer containing raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

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

Data Type

Byte Array

KnownOCSPHandle Property (SOAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle); Unicode (Windows) LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);
int64 secureblackbox_soapclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_soapclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is not available at design time.

Data Type

Long64

MimeType Property (SOAPClient Class)

Specifies the SOAP message MIME type.

Syntax

ANSI (Cross Platform)
char* GetMimeType();
int SetMimeType(const char* lpszMimeType); Unicode (Windows) LPWSTR GetMimeType();
INT SetMimeType(LPCWSTR lpszMimeType);
char* secureblackbox_soapclient_getmimetype(void* lpObj);
int secureblackbox_soapclient_setmimetype(void* lpObj, const char* lpszMimeType);
QString GetMimeType();
int SetMimeType(QString qsMimeType);

Default Value

""

Remarks

Use this property to specify the MIME type attribute of the SOAP message.

Data Type

String

OperationName Property (SOAPClient Class)

Specifies the SOAP operation name.

Syntax

ANSI (Cross Platform)
char* GetOperationName();
int SetOperationName(const char* lpszOperationName); Unicode (Windows) LPWSTR GetOperationName();
INT SetOperationName(LPCWSTR lpszOperationName);
char* secureblackbox_soapclient_getoperationname(void* lpObj);
int secureblackbox_soapclient_setoperationname(void* lpObj, const char* lpszOperationName);
QString GetOperationName();
int SetOperationName(QString qsOperationName);

Default Value

""

Remarks

Use this property to specify the name of the operation that the SOAP message corresponds to.

Set this property if InputFile, InputBytes or InputStream only contains the parameters of the operation in XML format. In this case, a new SOAP message will be created and sent to the service.

If one of the Input properties contains a valid SOAP message or an operation request in XML format, this property can be left empty.

Data Type

String

OperationNamespaceURI Property (SOAPClient Class)

Specifies the SOAP message operation namespace URI.

Syntax

ANSI (Cross Platform)
char* GetOperationNamespaceURI();
int SetOperationNamespaceURI(const char* lpszOperationNamespaceURI); Unicode (Windows) LPWSTR GetOperationNamespaceURI();
INT SetOperationNamespaceURI(LPCWSTR lpszOperationNamespaceURI);
char* secureblackbox_soapclient_getoperationnamespaceuri(void* lpObj);
int secureblackbox_soapclient_setoperationnamespaceuri(void* lpObj, const char* lpszOperationNamespaceURI);
QString GetOperationNamespaceURI();
int SetOperationNamespaceURI(QString qsOperationNamespaceURI);

Default Value

""

Remarks

This property specifies the operation namespace URI of the SOAP message.

Data Type

String

OperationResponseName Property (SOAPClient Class)

Specifies the operation name of the response message.

Syntax

ANSI (Cross Platform)
char* GetOperationResponseName();

Unicode (Windows)
LPWSTR GetOperationResponseName();
char* secureblackbox_soapclient_getoperationresponsename(void* lpObj);
QString GetOperationResponseName();

Default Value

""

Remarks

Use this property to get the operation name from the response message received from the SOAP service.

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

Data Type

String

OperationResponseNamespaceURI Property (SOAPClient Class)

Specifies the response SOAP message operation namespace URI.

Syntax

ANSI (Cross Platform)
char* GetOperationResponseNamespaceURI();

Unicode (Windows)
LPWSTR GetOperationResponseNamespaceURI();
char* secureblackbox_soapclient_getoperationresponsenamespaceuri(void* lpObj);
QString GetOperationResponseNamespaceURI();

Default Value

""

Remarks

Use this property to get the operation namespace URI from the response SOAP message.

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

Data Type

String

OperationResponseTextContent Property (SOAPClient Class)

Returns the text content of the response message.

Syntax

ANSI (Cross Platform)
char* GetOperationResponseTextContent();

Unicode (Windows)
LPWSTR GetOperationResponseTextContent();
char* secureblackbox_soapclient_getoperationresponsetextcontent(void* lpObj);
QString GetOperationResponseTextContent();

Default Value

""

Remarks

Use this property to get the text content of the operation of the response SOAP message.

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

Data Type

String

OperationResponseXML Property (SOAPClient Class)

Returns the XML content of the response SOAP message.

Syntax

ANSI (Cross Platform)
char* GetOperationResponseXML();

Unicode (Windows)
LPWSTR GetOperationResponseXML();
char* secureblackbox_soapclient_getoperationresponsexml(void* lpObj);
QString GetOperationResponseXML();

Default Value

""

Remarks

Use this property to get the XML content of the response message.

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

Data Type

String

OutputAttachmentBytes Property (SOAPClient Class)

Use this property to read the attachment received from the service.

Syntax

ANSI (Cross Platform)
int GetOutputAttachmentBytes(char* &lpOutputAttachmentBytes, int &lenOutputAttachmentBytes);

Unicode (Windows)
INT GetOutputAttachmentBytes(LPSTR &lpOutputAttachmentBytes, INT &lenOutputAttachmentBytes);
int secureblackbox_soapclient_getoutputattachmentbytes(void* lpObj, char** lpOutputAttachmentBytes, int* lenOutputAttachmentBytes);
QByteArray GetOutputAttachmentBytes();

Remarks

Check the content of this property after the operation has completed to read the received attachment data.

This property will only be set if OutputAttachmentFile and OutputAttachmentStream properties had not been assigned.

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

Data Type

Byte Array

OutputAttachmentFile Property (SOAPClient Class)

A path to a file where to save the attachment data.

Syntax

ANSI (Cross Platform)
char* GetOutputAttachmentFile();
int SetOutputAttachmentFile(const char* lpszOutputAttachmentFile); Unicode (Windows) LPWSTR GetOutputAttachmentFile();
INT SetOutputAttachmentFile(LPCWSTR lpszOutputAttachmentFile);
char* secureblackbox_soapclient_getoutputattachmentfile(void* lpObj);
int secureblackbox_soapclient_setoutputattachmentfile(void* lpObj, const char* lpszOutputAttachmentFile);
QString GetOutputAttachmentFile();
int SetOutputAttachmentFile(QString qsOutputAttachmentFile);

Default Value

""

Remarks

Provide a full path to the file where the attachment should be saved.

Data Type

String

OutputBytes Property (SOAPClient Class)

Use this property to read the output the class object has produced.

Syntax

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);
int secureblackbox_soapclient_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);
QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (SOAPClient Class)

A file where the response will be saved.

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_soapclient_getoutputfile(void* lpObj);
int secureblackbox_soapclient_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

Provide a full path to the file where the service response should be saved.

Data Type

String

ProxyAddress Property (SOAPClient Class)

The IP address of the proxy server.

Syntax

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress); Unicode (Windows) LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);
char* secureblackbox_soapclient_getproxyaddress(void* lpObj);
int secureblackbox_soapclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SOAPClient Class)

The authentication type used by the proxy server.

Syntax

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); Unicode (Windows) INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

Possible Values

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_NTLM(3)
int secureblackbox_soapclient_getproxyauthentication(void* lpObj);
int secureblackbox_soapclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Default Value

0

Remarks

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

Data Type

Integer

ProxyPassword Property (SOAPClient Class)

The password to authenticate to the proxy server.

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* secureblackbox_soapclient_getproxypassword(void* lpObj);
int secureblackbox_soapclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SOAPClient Class)

The port on the proxy server to connect to.

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int secureblackbox_soapclient_getproxyport(void* lpObj);
int secureblackbox_soapclient_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SOAPClient Class)

The type of the proxy server.

Syntax

ANSI (Cross Platform)
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); Unicode (Windows) INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);

Possible Values

CPT_NONE(0), 
CPT_SOCKS_4(1),
CPT_SOCKS_5(2),
CPT_WEB_TUNNEL(3),
CPT_HTTP(4)
int secureblackbox_soapclient_getproxyproxytype(void* lpObj);
int secureblackbox_soapclient_setproxyproxytype(void* lpObj, int iProxyProxyType);
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

Data Type

Integer

ProxyRequestHeaders Property (SOAPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders); Unicode (Windows) LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);
char* secureblackbox_soapclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_soapclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SOAPClient Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

ANSI (Cross Platform)
char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody); Unicode (Windows) LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);
char* secureblackbox_soapclient_getproxyresponsebody(void* lpObj);
int secureblackbox_soapclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (SOAPClient Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

ANSI (Cross Platform)
char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders); Unicode (Windows) LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);
char* secureblackbox_soapclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_soapclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (SOAPClient Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

ANSI (Cross Platform)
int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6); Unicode (Windows) BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);
int secureblackbox_soapclient_getproxyuseipv6(void* lpObj);
int secureblackbox_soapclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

Default Value

FALSE

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUseProxy Property (SOAPClient Class)

Enables or disables proxy-driven connection.

Syntax

ANSI (Cross Platform)
int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy); Unicode (Windows) BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);
int secureblackbox_soapclient_getproxyuseproxy(void* lpObj);
int secureblackbox_soapclient_setproxyuseproxy(void* lpObj, int bProxyUseProxy);
bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SOAPClient Class)

Specifies the username credential for proxy authentication.

Syntax

ANSI (Cross Platform)
char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername); Unicode (Windows) LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);
char* secureblackbox_soapclient_getproxyusername(void* lpObj);
int secureblackbox_soapclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ReasonPhrase Property (SOAPClient Class)

Contains the Reason Phrase element of the server's response.

Syntax

ANSI (Cross Platform)
char* GetReasonPhrase();

Unicode (Windows)
LPWSTR GetReasonPhrase();
char* secureblackbox_soapclient_getreasonphrase(void* lpObj);
QString GetReasonPhrase();

Default Value

""

Remarks

Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).

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

Data Type

String

ReqHeaderCount Property (SOAPClient Class)

The number of records in the ReqHeader arrays.

Syntax

ANSI (Cross Platform)
int GetReqHeaderCount();
int SetReqHeaderCount(int iReqHeaderCount); Unicode (Windows) INT GetReqHeaderCount();
INT SetReqHeaderCount(INT iReqHeaderCount);
int secureblackbox_soapclient_getreqheadercount(void* lpObj);
int secureblackbox_soapclient_setreqheadercount(void* lpObj, int iReqHeaderCount);
int GetReqHeaderCount();
int SetReqHeaderCount(int iReqHeaderCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

ReqHeaderCategory Property (SOAPClient Class)

Specifies the string category of the contained value.

Syntax

ANSI (Cross Platform)
char* GetReqHeaderCategory(int iReqHeaderIndex);
int SetReqHeaderCategory(int iReqHeaderIndex, const char* lpszReqHeaderCategory); Unicode (Windows) LPWSTR GetReqHeaderCategory(INT iReqHeaderIndex);
INT SetReqHeaderCategory(INT iReqHeaderIndex, LPCWSTR lpszReqHeaderCategory);
char* secureblackbox_soapclient_getreqheadercategory(void* lpObj, int reqheaderindex);
int secureblackbox_soapclient_setreqheadercategory(void* lpObj, int reqheaderindex, const char* lpszReqHeaderCategory);
QString GetReqHeaderCategory(int iReqHeaderIndex);
int SetReqHeaderCategory(int iReqHeaderIndex, QString qsReqHeaderCategory);

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqHeaderFormat Property (SOAPClient Class)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

ANSI (Cross Platform)
int GetReqHeaderFormat(int iReqHeaderIndex);
int SetReqHeaderFormat(int iReqHeaderIndex, int iReqHeaderFormat); Unicode (Windows) INT GetReqHeaderFormat(INT iReqHeaderIndex);
INT SetReqHeaderFormat(INT iReqHeaderIndex, INT iReqHeaderFormat);
int secureblackbox_soapclient_getreqheaderformat(void* lpObj, int reqheaderindex);
int secureblackbox_soapclient_setreqheaderformat(void* lpObj, int reqheaderindex, int iReqHeaderFormat);
int GetReqHeaderFormat(int iReqHeaderIndex);
int SetReqHeaderFormat(int iReqHeaderIndex, int iReqHeaderFormat);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the ReqHeaderValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

svfText0The property contains text

svfBinary1The property contains binary data. The Value property contains a hex encoding of it.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

Integer

ReqHeaderName Property (SOAPClient Class)

The name element in a (name, value) pair.

Syntax

ANSI (Cross Platform)
char* GetReqHeaderName(int iReqHeaderIndex);
int SetReqHeaderName(int iReqHeaderIndex, const char* lpszReqHeaderName); Unicode (Windows) LPWSTR GetReqHeaderName(INT iReqHeaderIndex);
INT SetReqHeaderName(INT iReqHeaderIndex, LPCWSTR lpszReqHeaderName);
char* secureblackbox_soapclient_getreqheadername(void* lpObj, int reqheaderindex);
int secureblackbox_soapclient_setreqheadername(void* lpObj, int reqheaderindex, const char* lpszReqHeaderName);
QString GetReqHeaderName(int iReqHeaderIndex);
int SetReqHeaderName(int iReqHeaderIndex, QString qsReqHeaderName);

Default Value

""

Remarks

The name element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqHeaderValue Property (SOAPClient Class)

The value element in a (name, value) pair.

Syntax

ANSI (Cross Platform)
char* GetReqHeaderValue(int iReqHeaderIndex);
int SetReqHeaderValue(int iReqHeaderIndex, const char* lpszReqHeaderValue); Unicode (Windows) LPWSTR GetReqHeaderValue(INT iReqHeaderIndex);
INT SetReqHeaderValue(INT iReqHeaderIndex, LPCWSTR lpszReqHeaderValue);
char* secureblackbox_soapclient_getreqheadervalue(void* lpObj, int reqheaderindex);
int secureblackbox_soapclient_setreqheadervalue(void* lpObj, int reqheaderindex, const char* lpszReqHeaderValue);
QString GetReqHeaderValue(int iReqHeaderIndex);
int SetReqHeaderValue(int iReqHeaderIndex, QString qsReqHeaderValue);

Default Value

""

Remarks

The value element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

This property is not available at design time.

Data Type

String

ReqParamsAccept Property (SOAPClient Class)

Specifies the Accept header property of the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsAccept();
int SetReqParamsAccept(const char* lpszReqParamsAccept); Unicode (Windows) LPWSTR GetReqParamsAccept();
INT SetReqParamsAccept(LPCWSTR lpszReqParamsAccept);
char* secureblackbox_soapclient_getreqparamsaccept(void* lpObj);
int secureblackbox_soapclient_setreqparamsaccept(void* lpObj, const char* lpszReqParamsAccept);
QString GetReqParamsAccept();
int SetReqParamsAccept(QString qsReqParamsAccept);

Default Value

""

Remarks

Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.

This property is not available at design time.

Data Type

String

ReqParamsAcceptCharset Property (SOAPClient Class)

Specifies the Accept-Charset header property of the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsAcceptCharset();
int SetReqParamsAcceptCharset(const char* lpszReqParamsAcceptCharset); Unicode (Windows) LPWSTR GetReqParamsAcceptCharset();
INT SetReqParamsAcceptCharset(LPCWSTR lpszReqParamsAcceptCharset);
char* secureblackbox_soapclient_getreqparamsacceptcharset(void* lpObj);
int secureblackbox_soapclient_setreqparamsacceptcharset(void* lpObj, const char* lpszReqParamsAcceptCharset);
QString GetReqParamsAcceptCharset();
int SetReqParamsAcceptCharset(QString qsReqParamsAcceptCharset);

Default Value

""

Remarks

Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptLanguage Property (SOAPClient Class)

Specifies the Accept-Language header property of the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsAcceptLanguage();
int SetReqParamsAcceptLanguage(const char* lpszReqParamsAcceptLanguage); Unicode (Windows) LPWSTR GetReqParamsAcceptLanguage();
INT SetReqParamsAcceptLanguage(LPCWSTR lpszReqParamsAcceptLanguage);
char* secureblackbox_soapclient_getreqparamsacceptlanguage(void* lpObj);
int secureblackbox_soapclient_setreqparamsacceptlanguage(void* lpObj, const char* lpszReqParamsAcceptLanguage);
QString GetReqParamsAcceptLanguage();
int SetReqParamsAcceptLanguage(QString qsReqParamsAcceptLanguage);

Default Value

""

Remarks

Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.

This property is not available at design time.

Data Type

String

ReqParamsAcceptRangeEnd Property (SOAPClient Class)

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Syntax

ANSI (Cross Platform)
int64 GetReqParamsAcceptRangeEnd();
int SetReqParamsAcceptRangeEnd(int64 lReqParamsAcceptRangeEnd); Unicode (Windows) LONG64 GetReqParamsAcceptRangeEnd();
INT SetReqParamsAcceptRangeEnd(LONG64 lReqParamsAcceptRangeEnd);
int64 secureblackbox_soapclient_getreqparamsacceptrangeend(void* lpObj);
int secureblackbox_soapclient_setreqparamsacceptrangeend(void* lpObj, int64 lReqParamsAcceptRangeEnd);
qint64 GetReqParamsAcceptRangeEnd();
int SetReqParamsAcceptRangeEnd(qint64 lReqParamsAcceptRangeEnd);

Default Value

0

Remarks

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAcceptRangeStart Property (SOAPClient Class)

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Syntax

ANSI (Cross Platform)
int64 GetReqParamsAcceptRangeStart();
int SetReqParamsAcceptRangeStart(int64 lReqParamsAcceptRangeStart); Unicode (Windows) LONG64 GetReqParamsAcceptRangeStart();
INT SetReqParamsAcceptRangeStart(LONG64 lReqParamsAcceptRangeStart);
int64 secureblackbox_soapclient_getreqparamsacceptrangestart(void* lpObj);
int secureblackbox_soapclient_setreqparamsacceptrangestart(void* lpObj, int64 lReqParamsAcceptRangeStart);
qint64 GetReqParamsAcceptRangeStart();
int SetReqParamsAcceptRangeStart(qint64 lReqParamsAcceptRangeStart);

Default Value

0

Remarks

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsAuthorization Property (SOAPClient Class)

Specifies the Authorization header of the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsAuthorization();
int SetReqParamsAuthorization(const char* lpszReqParamsAuthorization); Unicode (Windows) LPWSTR GetReqParamsAuthorization();
INT SetReqParamsAuthorization(LPCWSTR lpszReqParamsAuthorization);
char* secureblackbox_soapclient_getreqparamsauthorization(void* lpObj);
int secureblackbox_soapclient_setreqparamsauthorization(void* lpObj, const char* lpszReqParamsAuthorization);
QString GetReqParamsAuthorization();
int SetReqParamsAuthorization(QString qsReqParamsAuthorization);

Default Value

""

Remarks

Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.

This property is not available at design time.

Data Type

String

ReqParamsConnection Property (SOAPClient Class)

Specifies the value to pass to the Connection header property of HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsConnection();
int SetReqParamsConnection(const char* lpszReqParamsConnection); Unicode (Windows) LPWSTR GetReqParamsConnection();
INT SetReqParamsConnection(LPCWSTR lpszReqParamsConnection);
char* secureblackbox_soapclient_getreqparamsconnection(void* lpObj);
int secureblackbox_soapclient_setreqparamsconnection(void* lpObj, const char* lpszReqParamsConnection);
QString GetReqParamsConnection();
int SetReqParamsConnection(QString qsReqParamsConnection);

Default Value

""

Remarks

Specifies the value to pass to the Connection header field of HTTP request.

This property is not available at design time.

Data Type

String

ReqParamsContentLength Property (SOAPClient Class)

Specifies the size of the entity-body of the HTTP request.

Syntax

ANSI (Cross Platform)
int64 GetReqParamsContentLength();
int SetReqParamsContentLength(int64 lReqParamsContentLength); Unicode (Windows) LONG64 GetReqParamsContentLength();
INT SetReqParamsContentLength(LONG64 lReqParamsContentLength);
int64 secureblackbox_soapclient_getreqparamscontentlength(void* lpObj);
int secureblackbox_soapclient_setreqparamscontentlength(void* lpObj, int64 lReqParamsContentLength);
qint64 GetReqParamsContentLength();
int SetReqParamsContentLength(qint64 lReqParamsContentLength);

Default Value

0

Remarks

Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the class calculate it automatically.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeEnd Property (SOAPClient Class)

Specifies the upper bound used in the Content-Range header of the HTTP request.

Syntax

ANSI (Cross Platform)
int64 GetReqParamsContentRangeEnd();
int SetReqParamsContentRangeEnd(int64 lReqParamsContentRangeEnd); Unicode (Windows) LONG64 GetReqParamsContentRangeEnd();
INT SetReqParamsContentRangeEnd(LONG64 lReqParamsContentRangeEnd);
int64 secureblackbox_soapclient_getreqparamscontentrangeend(void* lpObj);
int secureblackbox_soapclient_setreqparamscontentrangeend(void* lpObj, int64 lReqParamsContentRangeEnd);
qint64 GetReqParamsContentRangeEnd();
int SetReqParamsContentRangeEnd(qint64 lReqParamsContentRangeEnd);

Default Value

0

Remarks

Specifies the upper bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeFullSize Property (SOAPClient Class)

Specifies the total length of the full entity-body of the HTTP request.

Syntax

ANSI (Cross Platform)
int64 GetReqParamsContentRangeFullSize();
int SetReqParamsContentRangeFullSize(int64 lReqParamsContentRangeFullSize); Unicode (Windows) LONG64 GetReqParamsContentRangeFullSize();
INT SetReqParamsContentRangeFullSize(LONG64 lReqParamsContentRangeFullSize);
int64 secureblackbox_soapclient_getreqparamscontentrangefullsize(void* lpObj);
int secureblackbox_soapclient_setreqparamscontentrangefullsize(void* lpObj, int64 lReqParamsContentRangeFullSize);
qint64 GetReqParamsContentRangeFullSize();
int SetReqParamsContentRangeFullSize(qint64 lReqParamsContentRangeFullSize);

Default Value

0

Remarks

Specifies the total length of the full entity-body of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentRangeStart Property (SOAPClient Class)

Specifies the lower bound used in the Content-Range header of the HTTP request.

Syntax

ANSI (Cross Platform)
int64 GetReqParamsContentRangeStart();
int SetReqParamsContentRangeStart(int64 lReqParamsContentRangeStart); Unicode (Windows) LONG64 GetReqParamsContentRangeStart();
INT SetReqParamsContentRangeStart(LONG64 lReqParamsContentRangeStart);
int64 secureblackbox_soapclient_getreqparamscontentrangestart(void* lpObj);
int secureblackbox_soapclient_setreqparamscontentrangestart(void* lpObj, int64 lReqParamsContentRangeStart);
qint64 GetReqParamsContentRangeStart();
int SetReqParamsContentRangeStart(qint64 lReqParamsContentRangeStart);

Default Value

0

Remarks

Specifies the lower bound used in the Content-Range header of the HTTP request.

This property is not available at design time.

Data Type

Long64

ReqParamsContentType Property (SOAPClient Class)

The Content-Type header property of the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsContentType();
int SetReqParamsContentType(const char* lpszReqParamsContentType); Unicode (Windows) LPWSTR GetReqParamsContentType();
INT SetReqParamsContentType(LPCWSTR lpszReqParamsContentType);
char* secureblackbox_soapclient_getreqparamscontenttype(void* lpObj);
int secureblackbox_soapclient_setreqparamscontenttype(void* lpObj, const char* lpszReqParamsContentType);
QString GetReqParamsContentType();
int SetReqParamsContentType(QString qsReqParamsContentType);

Default Value

""

Remarks

The Content-Type header field of the HTTP request.

This property is not available at design time.

Data Type

String

ReqParamsCookie Property (SOAPClient Class)

This header is expected to be assigned with cookies previously received from the server and stored by the client.

Syntax

ANSI (Cross Platform)
char* GetReqParamsCookie();
int SetReqParamsCookie(const char* lpszReqParamsCookie); Unicode (Windows) LPWSTR GetReqParamsCookie();
INT SetReqParamsCookie(LPCWSTR lpszReqParamsCookie);
char* secureblackbox_soapclient_getreqparamscookie(void* lpObj);
int secureblackbox_soapclient_setreqparamscookie(void* lpObj, const char* lpszReqParamsCookie);
QString GetReqParamsCookie();
int SetReqParamsCookie(QString qsReqParamsCookie);

Default Value

""

Remarks

This header is expected to be assigned with cookies previously received from the server and stored by the client.

This property is not available at design time.

Data Type

String

ReqParamsCustomHeaders Property (SOAPClient Class)

Assign any custom HTTP headers to be passed to the server to this property.

Syntax

ANSI (Cross Platform)
char* GetReqParamsCustomHeaders();
int SetReqParamsCustomHeaders(const char* lpszReqParamsCustomHeaders); Unicode (Windows) LPWSTR GetReqParamsCustomHeaders();
INT SetReqParamsCustomHeaders(LPCWSTR lpszReqParamsCustomHeaders);
char* secureblackbox_soapclient_getreqparamscustomheaders(void* lpObj);
int secureblackbox_soapclient_setreqparamscustomheaders(void* lpObj, const char* lpszReqParamsCustomHeaders);
QString GetReqParamsCustomHeaders();
int SetReqParamsCustomHeaders(QString qsReqParamsCustomHeaders);

Default Value

""

Remarks

Assign any custom HTTP headers to be passed to the server to this property.

This property is not available at design time.

Data Type

String

ReqParamsDate Property (SOAPClient Class)

The date and time of the request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsDate();
int SetReqParamsDate(const char* lpszReqParamsDate); Unicode (Windows) LPWSTR GetReqParamsDate();
INT SetReqParamsDate(LPCWSTR lpszReqParamsDate);
char* secureblackbox_soapclient_getreqparamsdate(void* lpObj);
int secureblackbox_soapclient_setreqparamsdate(void* lpObj, const char* lpszReqParamsDate);
QString GetReqParamsDate();
int SetReqParamsDate(QString qsReqParamsDate);

Default Value

""

Remarks

The date and time of the request.

This property is not available at design time.

Data Type

String

ReqParamsFrom Property (SOAPClient Class)

Contains the From header property of the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsFrom();
int SetReqParamsFrom(const char* lpszReqParamsFrom); Unicode (Windows) LPWSTR GetReqParamsFrom();
INT SetReqParamsFrom(LPCWSTR lpszReqParamsFrom);
char* secureblackbox_soapclient_getreqparamsfrom(void* lpObj);
int secureblackbox_soapclient_setreqparamsfrom(void* lpObj, const char* lpszReqParamsFrom);
QString GetReqParamsFrom();
int SetReqParamsFrom(QString qsReqParamsFrom);

Default Value

""

Remarks

Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent.

This property is not available at design time.

Data Type

String

ReqParamsHost Property (SOAPClient Class)

This property contains the Host header property of the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsHost();
int SetReqParamsHost(const char* lpszReqParamsHost); Unicode (Windows) LPWSTR GetReqParamsHost();
INT SetReqParamsHost(LPCWSTR lpszReqParamsHost);
char* secureblackbox_soapclient_getreqparamshost(void* lpObj);
int secureblackbox_soapclient_setreqparamshost(void* lpObj, const char* lpszReqParamsHost);
QString GetReqParamsHost();
int SetReqParamsHost(QString qsReqParamsHost);

Default Value

""

Remarks

This property contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested.

This property is not available at design time.

Data Type

String

ReqParamsHTTPVersion Property (SOAPClient Class)

Specifies the version of HTTP protocol to use: 1.

Syntax

ANSI (Cross Platform)
int GetReqParamsHTTPVersion();
int SetReqParamsHTTPVersion(int iReqParamsHTTPVersion); Unicode (Windows) INT GetReqParamsHTTPVersion();
INT SetReqParamsHTTPVersion(INT iReqParamsHTTPVersion);

Possible Values

CHV_HTTP10(0), 
CHV_HTTP11(1)
int secureblackbox_soapclient_getreqparamshttpversion(void* lpObj);
int secureblackbox_soapclient_setreqparamshttpversion(void* lpObj, int iReqParamsHTTPVersion);
int GetReqParamsHTTPVersion();
int SetReqParamsHTTPVersion(int iReqParamsHTTPVersion);

Default Value

1

Remarks

Specifies the version of HTTP protocol to use: 1.0 or 1.1.

chvHTTP10HTTP/1.0 (0)
chvHTTP11HTTP/1.1 (1)

This property is not available at design time.

Data Type

Integer

ReqParamsIfMatch Property (SOAPClient Class)

Contains the If-Match request header property.

Syntax

ANSI (Cross Platform)
char* GetReqParamsIfMatch();
int SetReqParamsIfMatch(const char* lpszReqParamsIfMatch); Unicode (Windows) LPWSTR GetReqParamsIfMatch();
INT SetReqParamsIfMatch(LPCWSTR lpszReqParamsIfMatch);
char* secureblackbox_soapclient_getreqparamsifmatch(void* lpObj);
int secureblackbox_soapclient_setreqparamsifmatch(void* lpObj, const char* lpszReqParamsIfMatch);
QString GetReqParamsIfMatch();
int SetReqParamsIfMatch(QString qsReqParamsIfMatch);

Default Value

""

Remarks

Contains the If-Match request header field. This property makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsIfModifiedSince Property (SOAPClient Class)

Contains the If-Modified-Since request header property.

Syntax

ANSI (Cross Platform)
char* GetReqParamsIfModifiedSince();
int SetReqParamsIfModifiedSince(const char* lpszReqParamsIfModifiedSince); Unicode (Windows) LPWSTR GetReqParamsIfModifiedSince();
INT SetReqParamsIfModifiedSince(LPCWSTR lpszReqParamsIfModifiedSince);
char* secureblackbox_soapclient_getreqparamsifmodifiedsince(void* lpObj);
int secureblackbox_soapclient_setreqparamsifmodifiedsince(void* lpObj, const char* lpszReqParamsIfModifiedSince);
QString GetReqParamsIfModifiedSince();
int SetReqParamsIfModifiedSince(QString qsReqParamsIfModifiedSince);

Default Value

""

Remarks

Contains the If-Modified-Since request header field. This property makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsIfNoneMatch Property (SOAPClient Class)

Contains the If-None-Match request header property.

Syntax

ANSI (Cross Platform)
char* GetReqParamsIfNoneMatch();
int SetReqParamsIfNoneMatch(const char* lpszReqParamsIfNoneMatch); Unicode (Windows) LPWSTR GetReqParamsIfNoneMatch();
INT SetReqParamsIfNoneMatch(LPCWSTR lpszReqParamsIfNoneMatch);
char* secureblackbox_soapclient_getreqparamsifnonematch(void* lpObj);
int secureblackbox_soapclient_setreqparamsifnonematch(void* lpObj, const char* lpszReqParamsIfNoneMatch);
QString GetReqParamsIfNoneMatch();
int SetReqParamsIfNoneMatch(QString qsReqParamsIfNoneMatch);

Default Value

""

Remarks

Contains the If-None-Match request header field. This property makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsIfUnmodifiedSince Property (SOAPClient Class)

Contains the If-Unmodified-Since request header property.

Syntax

ANSI (Cross Platform)
char* GetReqParamsIfUnmodifiedSince();
int SetReqParamsIfUnmodifiedSince(const char* lpszReqParamsIfUnmodifiedSince); Unicode (Windows) LPWSTR GetReqParamsIfUnmodifiedSince();
INT SetReqParamsIfUnmodifiedSince(LPCWSTR lpszReqParamsIfUnmodifiedSince);
char* secureblackbox_soapclient_getreqparamsifunmodifiedsince(void* lpObj);
int secureblackbox_soapclient_setreqparamsifunmodifiedsince(void* lpObj, const char* lpszReqParamsIfUnmodifiedSince);
QString GetReqParamsIfUnmodifiedSince();
int SetReqParamsIfUnmodifiedSince(QString qsReqParamsIfUnmodifiedSince);

Default Value

""

Remarks

Contains the If-Unmodified-Since request header field. This property makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server.

This property is not available at design time.

Data Type

String

ReqParamsPassword Property (SOAPClient Class)

Assign this property with the user's password.

Syntax

ANSI (Cross Platform)
char* GetReqParamsPassword();
int SetReqParamsPassword(const char* lpszReqParamsPassword); Unicode (Windows) LPWSTR GetReqParamsPassword();
INT SetReqParamsPassword(LPCWSTR lpszReqParamsPassword);
char* secureblackbox_soapclient_getreqparamspassword(void* lpObj);
int secureblackbox_soapclient_setreqparamspassword(void* lpObj, const char* lpszReqParamsPassword);
QString GetReqParamsPassword();
int SetReqParamsPassword(QString qsReqParamsPassword);

Default Value

""

Remarks

Assign this property with the user's password.

This property is not available at design time.

Data Type

String

ReqParamsReferer Property (SOAPClient Class)

The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

Syntax

ANSI (Cross Platform)
char* GetReqParamsReferer();
int SetReqParamsReferer(const char* lpszReqParamsReferer); Unicode (Windows) LPWSTR GetReqParamsReferer();
INT SetReqParamsReferer(LPCWSTR lpszReqParamsReferer);
char* secureblackbox_soapclient_getreqparamsreferer(void* lpObj);
int secureblackbox_soapclient_setreqparamsreferer(void* lpObj, const char* lpszReqParamsReferer);
QString GetReqParamsReferer();
int SetReqParamsReferer(QString qsReqParamsReferer);

Default Value

""

Remarks

The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

This property is not available at design time.

Data Type

String

ReqParamsUserAgent Property (SOAPClient Class)

The User-Agent property of the HTTP request provides information about the software that initiates the request.

Syntax

ANSI (Cross Platform)
char* GetReqParamsUserAgent();
int SetReqParamsUserAgent(const char* lpszReqParamsUserAgent); Unicode (Windows) LPWSTR GetReqParamsUserAgent();
INT SetReqParamsUserAgent(LPCWSTR lpszReqParamsUserAgent);
char* secureblackbox_soapclient_getreqparamsuseragent(void* lpObj);
int secureblackbox_soapclient_setreqparamsuseragent(void* lpObj, const char* lpszReqParamsUserAgent);
QString GetReqParamsUserAgent();
int SetReqParamsUserAgent(QString qsReqParamsUserAgent);

Default Value

""

Remarks

The User-Agent field of the HTTP request provides information about the software that initiates the request.

This property is not available at design time.

Data Type

String

ReqParamsUsername Property (SOAPClient Class)

Assign this property with the user's login name.

Syntax

ANSI (Cross Platform)
char* GetReqParamsUsername();
int SetReqParamsUsername(const char* lpszReqParamsUsername); Unicode (Windows) LPWSTR GetReqParamsUsername();
INT SetReqParamsUsername(LPCWSTR lpszReqParamsUsername);
char* secureblackbox_soapclient_getreqparamsusername(void* lpObj);
int secureblackbox_soapclient_setreqparamsusername(void* lpObj, const char* lpszReqParamsUsername);
QString GetReqParamsUsername();
int SetReqParamsUsername(QString qsReqParamsUsername);

Default Value

""

Remarks

Assign this property with the user's login name.

This property is not available at design time.

Data Type

String

RespHeaderCount Property (SOAPClient Class)

The number of records in the RespHeader arrays.

Syntax

ANSI (Cross Platform)
int GetRespHeaderCount();

Unicode (Windows)
INT GetRespHeaderCount();
int secureblackbox_soapclient_getrespheadercount(void* lpObj);
int GetRespHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

RespHeaderCategory Property (SOAPClient Class)

Specifies the string category of the contained value.

Syntax

ANSI (Cross Platform)
char* GetRespHeaderCategory(int iRespHeaderIndex);

Unicode (Windows)
LPWSTR GetRespHeaderCategory(INT iRespHeaderIndex);
char* secureblackbox_soapclient_getrespheadercategory(void* lpObj, int respheaderindex);
QString GetRespHeaderCategory(int iRespHeaderIndex);

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

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

Data Type

String

RespHeaderFormat Property (SOAPClient Class)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

ANSI (Cross Platform)
int GetRespHeaderFormat(int iRespHeaderIndex);

Unicode (Windows)
INT GetRespHeaderFormat(INT iRespHeaderIndex);
int secureblackbox_soapclient_getrespheaderformat(void* lpObj, int respheaderindex);
int GetRespHeaderFormat(int iRespHeaderIndex);

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the RespHeaderValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

svfText0The property contains text

svfBinary1The property contains binary data. The Value property contains a hex encoding of it.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

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

Data Type

Integer

RespHeaderName Property (SOAPClient Class)

The name element in a (name, value) pair.

Syntax

ANSI (Cross Platform)
char* GetRespHeaderName(int iRespHeaderIndex);

Unicode (Windows)
LPWSTR GetRespHeaderName(INT iRespHeaderIndex);
char* secureblackbox_soapclient_getrespheadername(void* lpObj, int respheaderindex);
QString GetRespHeaderName(int iRespHeaderIndex);

Default Value

""

Remarks

The name element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

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

Data Type

String

RespHeaderValue Property (SOAPClient Class)

The value element in a (name, value) pair.

Syntax

ANSI (Cross Platform)
char* GetRespHeaderValue(int iRespHeaderIndex);

Unicode (Windows)
LPWSTR GetRespHeaderValue(INT iRespHeaderIndex);
char* secureblackbox_soapclient_getrespheadervalue(void* lpObj, int respheaderindex);
QString GetRespHeaderValue(int iRespHeaderIndex);

Default Value

""

Remarks

The value element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

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

Data Type

String

RespParamsContentLength Property (SOAPClient Class)

Indicates the length of the response content in bytes.

Syntax

ANSI (Cross Platform)
int64 GetRespParamsContentLength();

Unicode (Windows)
LONG64 GetRespParamsContentLength();
int64 secureblackbox_soapclient_getrespparamscontentlength(void* lpObj);
qint64 GetRespParamsContentLength();

Default Value

0

Remarks

Indicates the length of the response content in bytes.

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

Data Type

Long64

RespParamsDate Property (SOAPClient Class)

The date and time at which the response was generated, in server time, in UTC.

Syntax

ANSI (Cross Platform)
char* GetRespParamsDate();

Unicode (Windows)
LPWSTR GetRespParamsDate();
char* secureblackbox_soapclient_getrespparamsdate(void* lpObj);
QString GetRespParamsDate();

Default Value

""

Remarks

The date and time at which the response was generated, in server time, in UTC.

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

Data Type

String

RespParamsReasonPhrase Property (SOAPClient Class)

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.

Syntax

ANSI (Cross Platform)
char* GetRespParamsReasonPhrase();

Unicode (Windows)
LPWSTR GetRespParamsReasonPhrase();
char* secureblackbox_soapclient_getrespparamsreasonphrase(void* lpObj);
QString GetRespParamsReasonPhrase();

Default Value

""

Remarks

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.

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

Data Type

String

RespParamsStatusCode Property (SOAPClient Class)

The server-generated status code of the request processing status.

Syntax

ANSI (Cross Platform)
int GetRespParamsStatusCode();

Unicode (Windows)
INT GetRespParamsStatusCode();
int secureblackbox_soapclient_getrespparamsstatuscode(void* lpObj);
int GetRespParamsStatusCode();

Default Value

0

Remarks

The server-generated status code of the request processing status.

The code is a 3-digit integer where the first digit defines the class of the response:

1Informational
2Success
3Redirection
4Client Error
5Server Error

Common examples are 200 (page served succesfully), 404 (page not found), 302 (redirect), and 500 (internal server error).

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

Data Type

Integer

ServerCertCount Property (SOAPClient Class)

The number of records in the ServerCert arrays.

Syntax

ANSI (Cross Platform)
int GetServerCertCount();

Unicode (Windows)
INT GetServerCertCount();
int secureblackbox_soapclient_getservercertcount(void* lpObj);
int GetServerCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

ServerCertBytes Property (SOAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetServerCertBytes(int iServerCertIndex, char* &lpServerCertBytes, int &lenServerCertBytes);

Unicode (Windows)
INT GetServerCertBytes(INT iServerCertIndex, LPSTR &lpServerCertBytes, INT &lenServerCertBytes);
int secureblackbox_soapclient_getservercertbytes(void* lpObj, int servercertindex, char** lpServerCertBytes, int* lenServerCertBytes);
QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns raw certificate data in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertCAKeyID Property (SOAPClient Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

ANSI (Cross Platform)
int GetServerCertCAKeyID(int iServerCertIndex, char* &lpServerCertCAKeyID, int &lenServerCertCAKeyID);

Unicode (Windows)
INT GetServerCertCAKeyID(INT iServerCertIndex, LPSTR &lpServerCertCAKeyID, INT &lenServerCertCAKeyID);
int secureblackbox_soapclient_getservercertcakeyid(void* lpObj, int servercertindex, char** lpServerCertCAKeyID, int* lenServerCertCAKeyID);
QByteArray GetServerCertCAKeyID(int iServerCertIndex);

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertFingerprint Property (SOAPClient Class)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

ANSI (Cross Platform)
int GetServerCertFingerprint(int iServerCertIndex, char* &lpServerCertFingerprint, int &lenServerCertFingerprint);

Unicode (Windows)
INT GetServerCertFingerprint(INT iServerCertIndex, LPSTR &lpServerCertFingerprint, INT &lenServerCertFingerprint);
int secureblackbox_soapclient_getservercertfingerprint(void* lpObj, int servercertindex, char** lpServerCertFingerprint, int* lenServerCertFingerprint);
QByteArray GetServerCertFingerprint(int iServerCertIndex);

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertHandle Property (SOAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetServerCertHandle(int iServerCertIndex);

Unicode (Windows)
LONG64 GetServerCertHandle(INT iServerCertIndex);
int64 secureblackbox_soapclient_getservercerthandle(void* lpObj, int servercertindex);
qint64 GetServerCertHandle(int iServerCertIndex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Long64

ServerCertIssuer Property (SOAPClient Class)

The common name of the certificate issuer (CA), typically a company name.

Syntax

ANSI (Cross Platform)
char* GetServerCertIssuer(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertIssuer(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertissuer(void* lpObj, int servercertindex);
QString GetServerCertIssuer(int iServerCertIndex);

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertIssuerRDN Property (SOAPClient Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

ANSI (Cross Platform)
char* GetServerCertIssuerRDN(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertIssuerRDN(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertissuerrdn(void* lpObj, int servercertindex);
QString GetServerCertIssuerRDN(int iServerCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertKeyAlgorithm Property (SOAPClient Class)

Specifies the public key algorithm of this certificate.

Syntax

ANSI (Cross Platform)
char* GetServerCertKeyAlgorithm(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertKeyAlgorithm(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertkeyalgorithm(void* lpObj, int servercertindex);
QString GetServerCertKeyAlgorithm(int iServerCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertKeyBits Property (SOAPClient Class)

Returns the length of the public key.

Syntax

ANSI (Cross Platform)
int GetServerCertKeyBits(int iServerCertIndex);

Unicode (Windows)
INT GetServerCertKeyBits(INT iServerCertIndex);
int secureblackbox_soapclient_getservercertkeybits(void* lpObj, int servercertindex);
int GetServerCertKeyBits(int iServerCertIndex);

Default Value

0

Remarks

Returns the length of the public key.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Integer

ServerCertKeyFingerprint Property (SOAPClient Class)

Returns a fingerprint of the public key contained in the certificate.

Syntax

ANSI (Cross Platform)
int GetServerCertKeyFingerprint(int iServerCertIndex, char* &lpServerCertKeyFingerprint, int &lenServerCertKeyFingerprint);

Unicode (Windows)
INT GetServerCertKeyFingerprint(INT iServerCertIndex, LPSTR &lpServerCertKeyFingerprint, INT &lenServerCertKeyFingerprint);
int secureblackbox_soapclient_getservercertkeyfingerprint(void* lpObj, int servercertindex, char** lpServerCertKeyFingerprint, int* lenServerCertKeyFingerprint);
QByteArray GetServerCertKeyFingerprint(int iServerCertIndex);

Remarks

Returns a fingerprint of the public key contained in the certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertKeyUsage Property (SOAPClient Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

ANSI (Cross Platform)
int GetServerCertKeyUsage(int iServerCertIndex);

Unicode (Windows)
INT GetServerCertKeyUsage(INT iServerCertIndex);
int secureblackbox_soapclient_getservercertkeyusage(void* lpObj, int servercertindex);
int GetServerCertKeyUsage(int iServerCertIndex);

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Integer

ServerCertPublicKeyBytes Property (SOAPClient Class)

Contains the certificate's public key in DER format.

Syntax

ANSI (Cross Platform)
int GetServerCertPublicKeyBytes(int iServerCertIndex, char* &lpServerCertPublicKeyBytes, int &lenServerCertPublicKeyBytes);

Unicode (Windows)
INT GetServerCertPublicKeyBytes(INT iServerCertIndex, LPSTR &lpServerCertPublicKeyBytes, INT &lenServerCertPublicKeyBytes);
int secureblackbox_soapclient_getservercertpublickeybytes(void* lpObj, int servercertindex, char** lpServerCertPublicKeyBytes, int* lenServerCertPublicKeyBytes);
QByteArray GetServerCertPublicKeyBytes(int iServerCertIndex);

Remarks

Contains the certificate's public key in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertSelfSigned Property (SOAPClient Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

ANSI (Cross Platform)
int GetServerCertSelfSigned(int iServerCertIndex);

Unicode (Windows)
BOOL GetServerCertSelfSigned(INT iServerCertIndex);
int secureblackbox_soapclient_getservercertselfsigned(void* lpObj, int servercertindex);
bool GetServerCertSelfSigned(int iServerCertIndex);

Default Value

FALSE

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Boolean

ServerCertSerialNumber Property (SOAPClient Class)

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
int GetServerCertSerialNumber(int iServerCertIndex, char* &lpServerCertSerialNumber, int &lenServerCertSerialNumber);

Unicode (Windows)
INT GetServerCertSerialNumber(INT iServerCertIndex, LPSTR &lpServerCertSerialNumber, INT &lenServerCertSerialNumber);
int secureblackbox_soapclient_getservercertserialnumber(void* lpObj, int servercertindex, char** lpServerCertSerialNumber, int* lenServerCertSerialNumber);
QByteArray GetServerCertSerialNumber(int iServerCertIndex);

Remarks

Returns the certificate's serial number.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertSigAlgorithm Property (SOAPClient Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

ANSI (Cross Platform)
char* GetServerCertSigAlgorithm(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSigAlgorithm(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertsigalgorithm(void* lpObj, int servercertindex);
QString GetServerCertSigAlgorithm(int iServerCertIndex);

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertSubject Property (SOAPClient Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

ANSI (Cross Platform)
char* GetServerCertSubject(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSubject(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertsubject(void* lpObj, int servercertindex);
QString GetServerCertSubject(int iServerCertIndex);

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertSubjectKeyID Property (SOAPClient Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

ANSI (Cross Platform)
int GetServerCertSubjectKeyID(int iServerCertIndex, char* &lpServerCertSubjectKeyID, int &lenServerCertSubjectKeyID);

Unicode (Windows)
INT GetServerCertSubjectKeyID(INT iServerCertIndex, LPSTR &lpServerCertSubjectKeyID, INT &lenServerCertSubjectKeyID);
int secureblackbox_soapclient_getservercertsubjectkeyid(void* lpObj, int servercertindex, char** lpServerCertSubjectKeyID, int* lenServerCertSubjectKeyID);
QByteArray GetServerCertSubjectKeyID(int iServerCertIndex);

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertSubjectRDN Property (SOAPClient Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

ANSI (Cross Platform)
char* GetServerCertSubjectRDN(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSubjectRDN(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertsubjectrdn(void* lpObj, int servercertindex);
QString GetServerCertSubjectRDN(int iServerCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertValidFrom Property (SOAPClient Class)

The time point at which the certificate becomes valid, in UTC.

Syntax

ANSI (Cross Platform)
char* GetServerCertValidFrom(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertValidFrom(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertvalidfrom(void* lpObj, int servercertindex);
QString GetServerCertValidFrom(int iServerCertIndex);

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertValidTo Property (SOAPClient Class)

The time point at which the certificate expires, in UTC.

Syntax

ANSI (Cross Platform)
char* GetServerCertValidTo(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertValidTo(INT iServerCertIndex);
char* secureblackbox_soapclient_getservercertvalidto(void* lpObj, int servercertindex);
QString GetServerCertValidTo(int iServerCertIndex);

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

SOAPAction Property (SOAPClient Class)

Specifies the SOAP action.

Syntax

ANSI (Cross Platform)
char* GetSOAPAction();
int SetSOAPAction(const char* lpszSOAPAction); Unicode (Windows) LPWSTR GetSOAPAction();
INT SetSOAPAction(LPCWSTR lpszSOAPAction);
char* secureblackbox_soapclient_getsoapaction(void* lpObj);
int secureblackbox_soapclient_setsoapaction(void* lpObj, const char* lpszSOAPAction);
QString GetSOAPAction();
int SetSOAPAction(QString qsSOAPAction);

Default Value

""

Remarks

Use this property to specify the value for the SOAPAction/action HTTP request header field. This field is normally used to indicate the intent of the SOAP request.

Data Type

String

SOAPResponseType Property (SOAPClient Class)

The type of the response.

Syntax

ANSI (Cross Platform)
int GetSOAPResponseType();

Unicode (Windows)
INT GetSOAPResponseType();

Possible Values

SRT_UNKNOWN(0), 
SRT_BINARY(1),
SRT_XMLDOCUMENT(2),
SRT_SOAPMESSAGE(3)
int secureblackbox_soapclient_getsoapresponsetype(void* lpObj);
int GetSOAPResponseType();

Default Value

0

Remarks

Use this property to learn about the type (format) of the response provided by the SOAP service.

srtUnknown0It was not possible to identify the response type. Either connection error has occurred or the service returned an unexpected HTTP status code.
srtBinary1The SOAP service has returned binary data.
srtXMLDocument2The SOAP service has returned an XML document.
srtSOAPMessage3The SOAP service has returned a SOAP message.

This property is read-only.

Data Type

Integer

SOAPVersion Property (SOAPClient Class)

Specifies SOAP version.

Syntax

ANSI (Cross Platform)
int GetSOAPVersion();
int SetSOAPVersion(int iSOAPVersion); Unicode (Windows) INT GetSOAPVersion();
INT SetSOAPVersion(INT iSOAPVersion);

Possible Values

SPV_AUTO(0), 
SPV_11(1),
SPV_12(2)
int secureblackbox_soapclient_getsoapversion(void* lpObj);
int secureblackbox_soapclient_setsoapversion(void* lpObj, int iSOAPVersion);
int GetSOAPVersion();
int SetSOAPVersion(int iSOAPVersion);

Default Value

0

Remarks

This property specifies the version of the SOAP protocol. This SOAP version will be used to create a SOAP message (if needed) and to communicate with the service.

spvAuto0The SOAP version is detected from the SOAP message provided. If the input does not consitute a SOAP message, version 1.2 will be used.
spv111SOAP version 1.1
spv122SOAP version 1.2

Data Type

Integer

SocketDNSMode Property (SOAPClient Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Syntax

ANSI (Cross Platform)
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); Unicode (Windows) INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);

Possible Values

DM_AUTO(0), 
DM_PLATFORM(1),
DM_OWN(2),
DM_OWN_SECURE(3)
int secureblackbox_soapclient_getsocketdnsmode(void* lpObj);
int secureblackbox_soapclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

Data Type

Integer

SocketDNSPort Property (SOAPClient Class)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

ANSI (Cross Platform)
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); Unicode (Windows) INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);
int secureblackbox_soapclient_getsocketdnsport(void* lpObj);
int secureblackbox_soapclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SOAPClient Class)

The timeout (in milliseconds) for each DNS query.

Syntax

ANSI (Cross Platform)
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); Unicode (Windows) INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);
int secureblackbox_soapclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_soapclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketDNSServers Property (SOAPClient Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

ANSI (Cross Platform)
char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers); Unicode (Windows) LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);
char* secureblackbox_soapclient_getsocketdnsservers(void* lpObj);
int secureblackbox_soapclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SOAPClient Class)

The timeout (in milliseconds) for the whole resolution process.

Syntax

ANSI (Cross Platform)
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); Unicode (Windows) INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);
int secureblackbox_soapclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_soapclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SOAPClient Class)

The maximum number of bytes to read from the socket, per second.

Syntax

ANSI (Cross Platform)
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); Unicode (Windows) INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);
int secureblackbox_soapclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_soapclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SOAPClient Class)

The local network interface to bind the socket to.

Syntax

ANSI (Cross Platform)
char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress); Unicode (Windows) LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);
char* secureblackbox_soapclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_soapclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SOAPClient Class)

The local port number to bind the socket to.

Syntax

ANSI (Cross Platform)
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); Unicode (Windows) INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);
int secureblackbox_soapclient_getsocketlocalport(void* lpObj);
int secureblackbox_soapclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SOAPClient Class)

The maximum number of bytes to write to the socket, per second.

Syntax

ANSI (Cross Platform)
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); Unicode (Windows) INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);
int secureblackbox_soapclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_soapclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SOAPClient Class)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

ANSI (Cross Platform)
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); Unicode (Windows) INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);
int secureblackbox_soapclient_getsockettimeout(void* lpObj);
int secureblackbox_soapclient_setsockettimeout(void* lpObj, int iSocketTimeout);
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SOAPClient Class)

Enables or disables IP protocol version 6.

Syntax

ANSI (Cross Platform)
int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6); Unicode (Windows) BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);
int secureblackbox_soapclient_getsocketuseipv6(void* lpObj);
int secureblackbox_soapclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StatusCode Property (SOAPClient Class)

Contains the Status Code element of the server's response.

Syntax

ANSI (Cross Platform)
int GetStatusCode();

Unicode (Windows)
INT GetStatusCode();
int secureblackbox_soapclient_getstatuscode(void* lpObj);
int GetStatusCode();

Default Value

0

Remarks

Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).

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

Data Type

Integer

TLSAutoValidateCertificates Property (SOAPClient Class)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

ANSI (Cross Platform)
int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates); Unicode (Windows) BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);
int secureblackbox_soapclient_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_soapclient_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);

Default Value

TRUE

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (SOAPClient Class)

Selects the base configuration for the TLS settings.

Syntax

ANSI (Cross Platform)
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); Unicode (Windows) INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);

Possible Values

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
int secureblackbox_soapclient_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_soapclient_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Data Type

Integer

TLSCiphersuites Property (SOAPClient Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

ANSI (Cross Platform)
char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites); Unicode (Windows) LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);
char* secureblackbox_soapclient_gettlsciphersuites(void* lpObj);
int secureblackbox_soapclient_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

  • NULL_NULL_NULL
  • RSA_NULL_MD5
  • RSA_NULL_SHA
  • RSA_RC4_MD5
  • RSA_RC4_SHA
  • RSA_RC2_MD5
  • RSA_IDEA_MD5
  • RSA_IDEA_SHA
  • RSA_DES_MD5
  • RSA_DES_SHA
  • RSA_3DES_MD5
  • RSA_3DES_SHA
  • RSA_AES128_SHA
  • RSA_AES256_SHA
  • DH_DSS_DES_SHA
  • DH_DSS_3DES_SHA
  • DH_DSS_AES128_SHA
  • DH_DSS_AES256_SHA
  • DH_RSA_DES_SHA
  • DH_RSA_3DES_SHA
  • DH_RSA_AES128_SHA
  • DH_RSA_AES256_SHA
  • DHE_DSS_DES_SHA
  • DHE_DSS_3DES_SHA
  • DHE_DSS_AES128_SHA
  • DHE_DSS_AES256_SHA
  • DHE_RSA_DES_SHA
  • DHE_RSA_3DES_SHA
  • DHE_RSA_AES128_SHA
  • DHE_RSA_AES256_SHA
  • DH_ANON_RC4_MD5
  • DH_ANON_DES_SHA
  • DH_ANON_3DES_SHA
  • DH_ANON_AES128_SHA
  • DH_ANON_AES256_SHA
  • RSA_RC2_MD5_EXPORT
  • RSA_RC4_MD5_EXPORT
  • RSA_DES_SHA_EXPORT
  • DH_DSS_DES_SHA_EXPORT
  • DH_RSA_DES_SHA_EXPORT
  • DHE_DSS_DES_SHA_EXPORT
  • DHE_RSA_DES_SHA_EXPORT
  • DH_ANON_RC4_MD5_EXPORT
  • DH_ANON_DES_SHA_EXPORT
  • RSA_CAMELLIA128_SHA
  • DH_DSS_CAMELLIA128_SHA
  • DH_RSA_CAMELLIA128_SHA
  • DHE_DSS_CAMELLIA128_SHA
  • DHE_RSA_CAMELLIA128_SHA
  • DH_ANON_CAMELLIA128_SHA
  • RSA_CAMELLIA256_SHA
  • DH_DSS_CAMELLIA256_SHA
  • DH_RSA_CAMELLIA256_SHA
  • DHE_DSS_CAMELLIA256_SHA
  • DHE_RSA_CAMELLIA256_SHA
  • DH_ANON_CAMELLIA256_SHA
  • PSK_RC4_SHA
  • PSK_3DES_SHA
  • PSK_AES128_SHA
  • PSK_AES256_SHA
  • DHE_PSK_RC4_SHA
  • DHE_PSK_3DES_SHA
  • DHE_PSK_AES128_SHA
  • DHE_PSK_AES256_SHA
  • RSA_PSK_RC4_SHA
  • RSA_PSK_3DES_SHA
  • RSA_PSK_AES128_SHA
  • RSA_PSK_AES256_SHA
  • RSA_SEED_SHA
  • DH_DSS_SEED_SHA
  • DH_RSA_SEED_SHA
  • DHE_DSS_SEED_SHA
  • DHE_RSA_SEED_SHA
  • DH_ANON_SEED_SHA
  • SRP_SHA_3DES_SHA
  • SRP_SHA_RSA_3DES_SHA
  • SRP_SHA_DSS_3DES_SHA
  • SRP_SHA_AES128_SHA
  • SRP_SHA_RSA_AES128_SHA
  • SRP_SHA_DSS_AES128_SHA
  • SRP_SHA_AES256_SHA
  • SRP_SHA_RSA_AES256_SHA
  • SRP_SHA_DSS_AES256_SHA
  • ECDH_ECDSA_NULL_SHA
  • ECDH_ECDSA_RC4_SHA
  • ECDH_ECDSA_3DES_SHA
  • ECDH_ECDSA_AES128_SHA
  • ECDH_ECDSA_AES256_SHA
  • ECDHE_ECDSA_NULL_SHA
  • ECDHE_ECDSA_RC4_SHA
  • ECDHE_ECDSA_3DES_SHA
  • ECDHE_ECDSA_AES128_SHA
  • ECDHE_ECDSA_AES256_SHA
  • ECDH_RSA_NULL_SHA
  • ECDH_RSA_RC4_SHA
  • ECDH_RSA_3DES_SHA
  • ECDH_RSA_AES128_SHA
  • ECDH_RSA_AES256_SHA
  • ECDHE_RSA_NULL_SHA
  • ECDHE_RSA_RC4_SHA
  • ECDHE_RSA_3DES_SHA
  • ECDHE_RSA_AES128_SHA
  • ECDHE_RSA_AES256_SHA
  • ECDH_ANON_NULL_SHA
  • ECDH_ANON_RC4_SHA
  • ECDH_ANON_3DES_SHA
  • ECDH_ANON_AES128_SHA
  • ECDH_ANON_AES256_SHA
  • RSA_NULL_SHA256
  • RSA_AES128_SHA256
  • RSA_AES256_SHA256
  • DH_DSS_AES128_SHA256
  • DH_RSA_AES128_SHA256
  • DHE_DSS_AES128_SHA256
  • DHE_RSA_AES128_SHA256
  • DH_DSS_AES256_SHA256
  • DH_RSA_AES256_SHA256
  • DHE_DSS_AES256_SHA256
  • DHE_RSA_AES256_SHA256
  • DH_ANON_AES128_SHA256
  • DH_ANON_AES256_SHA256
  • RSA_AES128_GCM_SHA256
  • RSA_AES256_GCM_SHA384
  • DHE_RSA_AES128_GCM_SHA256
  • DHE_RSA_AES256_GCM_SHA384
  • DH_RSA_AES128_GCM_SHA256
  • DH_RSA_AES256_GCM_SHA384
  • DHE_DSS_AES128_GCM_SHA256
  • DHE_DSS_AES256_GCM_SHA384
  • DH_DSS_AES128_GCM_SHA256
  • DH_DSS_AES256_GCM_SHA384
  • DH_ANON_AES128_GCM_SHA256
  • DH_ANON_AES256_GCM_SHA384
  • ECDHE_ECDSA_AES128_SHA256
  • ECDHE_ECDSA_AES256_SHA384
  • ECDH_ECDSA_AES128_SHA256
  • ECDH_ECDSA_AES256_SHA384
  • ECDHE_RSA_AES128_SHA256
  • ECDHE_RSA_AES256_SHA384
  • ECDH_RSA_AES128_SHA256
  • ECDH_RSA_AES256_SHA384
  • ECDHE_ECDSA_AES128_GCM_SHA256
  • ECDHE_ECDSA_AES256_GCM_SHA384
  • ECDH_ECDSA_AES128_GCM_SHA256
  • ECDH_ECDSA_AES256_GCM_SHA384
  • ECDHE_RSA_AES128_GCM_SHA256
  • ECDHE_RSA_AES256_GCM_SHA384
  • ECDH_RSA_AES128_GCM_SHA256
  • ECDH_RSA_AES256_GCM_SHA384
  • PSK_AES128_GCM_SHA256
  • PSK_AES256_GCM_SHA384
  • DHE_PSK_AES128_GCM_SHA256
  • DHE_PSK_AES256_GCM_SHA384
  • RSA_PSK_AES128_GCM_SHA256
  • RSA_PSK_AES256_GCM_SHA384
  • PSK_AES128_SHA256
  • PSK_AES256_SHA384
  • PSK_NULL_SHA256
  • PSK_NULL_SHA384
  • DHE_PSK_AES128_SHA256
  • DHE_PSK_AES256_SHA384
  • DHE_PSK_NULL_SHA256
  • DHE_PSK_NULL_SHA384
  • RSA_PSK_AES128_SHA256
  • RSA_PSK_AES256_SHA384
  • RSA_PSK_NULL_SHA256
  • RSA_PSK_NULL_SHA384
  • RSA_CAMELLIA128_SHA256
  • DH_DSS_CAMELLIA128_SHA256
  • DH_RSA_CAMELLIA128_SHA256
  • DHE_DSS_CAMELLIA128_SHA256
  • DHE_RSA_CAMELLIA128_SHA256
  • DH_ANON_CAMELLIA128_SHA256
  • RSA_CAMELLIA256_SHA256
  • DH_DSS_CAMELLIA256_SHA256
  • DH_RSA_CAMELLIA256_SHA256
  • DHE_DSS_CAMELLIA256_SHA256
  • DHE_RSA_CAMELLIA256_SHA256
  • DH_ANON_CAMELLIA256_SHA256
  • ECDHE_ECDSA_CAMELLIA128_SHA256
  • ECDHE_ECDSA_CAMELLIA256_SHA384
  • ECDH_ECDSA_CAMELLIA128_SHA256
  • ECDH_ECDSA_CAMELLIA256_SHA384
  • ECDHE_RSA_CAMELLIA128_SHA256
  • ECDHE_RSA_CAMELLIA256_SHA384
  • ECDH_RSA_CAMELLIA128_SHA256
  • ECDH_RSA_CAMELLIA256_SHA384
  • RSA_CAMELLIA128_GCM_SHA256
  • RSA_CAMELLIA256_GCM_SHA384
  • DHE_RSA_CAMELLIA128_GCM_SHA256
  • DHE_RSA_CAMELLIA256_GCM_SHA384
  • DH_RSA_CAMELLIA128_GCM_SHA256
  • DH_RSA_CAMELLIA256_GCM_SHA384
  • DHE_DSS_CAMELLIA128_GCM_SHA256
  • DHE_DSS_CAMELLIA256_GCM_SHA384
  • DH_DSS_CAMELLIA128_GCM_SHA256
  • DH_DSS_CAMELLIA256_GCM_SHA384
  • DH_anon_CAMELLIA128_GCM_SHA256
  • DH_anon_CAMELLIA256_GCM_SHA384
  • ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
  • ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
  • ECDH_ECDSA_CAMELLIA128_GCM_SHA256
  • ECDH_ECDSA_CAMELLIA256_GCM_SHA384
  • ECDHE_RSA_CAMELLIA128_GCM_SHA256
  • ECDHE_RSA_CAMELLIA256_GCM_SHA384
  • ECDH_RSA_CAMELLIA128_GCM_SHA256
  • ECDH_RSA_CAMELLIA256_GCM_SHA384
  • PSK_CAMELLIA128_GCM_SHA256
  • PSK_CAMELLIA256_GCM_SHA384
  • DHE_PSK_CAMELLIA128_GCM_SHA256
  • DHE_PSK_CAMELLIA256_GCM_SHA384
  • RSA_PSK_CAMELLIA128_GCM_SHA256
  • RSA_PSK_CAMELLIA256_GCM_SHA384
  • PSK_CAMELLIA128_SHA256
  • PSK_CAMELLIA256_SHA384
  • DHE_PSK_CAMELLIA128_SHA256
  • DHE_PSK_CAMELLIA256_SHA384
  • RSA_PSK_CAMELLIA128_SHA256
  • RSA_PSK_CAMELLIA256_SHA384
  • ECDHE_PSK_CAMELLIA128_SHA256
  • ECDHE_PSK_CAMELLIA256_SHA384
  • ECDHE_PSK_RC4_SHA
  • ECDHE_PSK_3DES_SHA
  • ECDHE_PSK_AES128_SHA
  • ECDHE_PSK_AES256_SHA
  • ECDHE_PSK_AES128_SHA256
  • ECDHE_PSK_AES256_SHA384
  • ECDHE_PSK_NULL_SHA
  • ECDHE_PSK_NULL_SHA256
  • ECDHE_PSK_NULL_SHA384
  • ECDHE_RSA_CHACHA20_POLY1305_SHA256
  • ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
  • DHE_RSA_CHACHA20_POLY1305_SHA256
  • PSK_CHACHA20_POLY1305_SHA256
  • ECDHE_PSK_CHACHA20_POLY1305_SHA256
  • DHE_PSK_CHACHA20_POLY1305_SHA256
  • RSA_PSK_CHACHA20_POLY1305_SHA256
  • AES128_GCM_SHA256
  • AES256_GCM_SHA384
  • CHACHA20_POLY1305_SHA256
  • AES128_CCM_SHA256
  • AES128_CCM8_SHA256

Data Type

String

TLSECCurves Property (SOAPClient Class)

Defines the elliptic curves to enable.

Syntax

ANSI (Cross Platform)
char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves); Unicode (Windows) LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);
char* secureblackbox_soapclient_gettlseccurves(void* lpObj);
int secureblackbox_soapclient_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SOAPClient Class)

Provides access to TLS extensions.

Syntax

ANSI (Cross Platform)
char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions); Unicode (Windows) LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);
char* secureblackbox_soapclient_gettlsextensions(void* lpObj);
int secureblackbox_soapclient_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SOAPClient Class)

Whether to force TLS session resumption when the destination address changes.

Syntax

ANSI (Cross Platform)
int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges); Unicode (Windows) BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);
int secureblackbox_soapclient_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_soapclient_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);

Default Value

FALSE

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (SOAPClient Class)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(const char* lpszTLSPreSharedIdentity); Unicode (Windows) LPWSTR GetTLSPreSharedIdentity();
INT SetTLSPreSharedIdentity(LPCWSTR lpszTLSPreSharedIdentity);
char* secureblackbox_soapclient_gettlspresharedidentity(void* lpObj);
int secureblackbox_soapclient_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SOAPClient Class)

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedKey();
int SetTLSPreSharedKey(const char* lpszTLSPreSharedKey); Unicode (Windows) LPWSTR GetTLSPreSharedKey();
INT SetTLSPreSharedKey(LPCWSTR lpszTLSPreSharedKey);
char* secureblackbox_soapclient_gettlspresharedkey(void* lpObj);
int secureblackbox_soapclient_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);

Default Value

""

Remarks

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SOAPClient Class)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(const char* lpszTLSPreSharedKeyCiphersuite); Unicode (Windows) LPWSTR GetTLSPreSharedKeyCiphersuite();
INT SetTLSPreSharedKeyCiphersuite(LPCWSTR lpszTLSPreSharedKeyCiphersuite);
char* secureblackbox_soapclient_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_soapclient_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SOAPClient Class)

Selects renegotiation attack prevention mechanism.

Syntax

ANSI (Cross Platform)
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); Unicode (Windows) INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);

Possible Values

CRAPM_COMPATIBLE(0), 
CRAPM_STRICT(1),
CRAPM_AUTO(2)
int secureblackbox_soapclient_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_soapclient_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

Data Type

Integer

TLSRevocationCheck Property (SOAPClient Class)

Specifies the kind(s) of revocation check to perform.

Syntax

ANSI (Cross Platform)
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); Unicode (Windows) INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);

Possible Values

CRC_NONE(0), 
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
int secureblackbox_soapclient_gettlsrevocationcheck(void* lpObj);
int secureblackbox_soapclient_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

crcNone0No revocation checking
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2Check all provided CRL endpoints for all chain certificates.
crcAllOCSP3Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP4Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL5At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP6At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP7At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SOAPClient Class)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

ANSI (Cross Platform)
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); Unicode (Windows) INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);
int secureblackbox_soapclient_gettlsssloptions(void* lpObj);
int secureblackbox_soapclient_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send handshake message as large batches rather than individually

Data Type

Integer

TLSTLSMode Property (SOAPClient Class)

Specifies the TLS mode to use.

Syntax

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); Unicode (Windows) INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

Possible Values

SM_DEFAULT(0), 
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
int secureblackbox_soapclient_gettlstlsmode(void* lpObj);
int secureblackbox_soapclient_settlstlsmode(void* lpObj, int iTLSTLSMode);
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Default Value

0

Remarks

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, allow plain data.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SOAPClient Class)

Enables Extended Master Secret Extension, as defined in RFC 7627.

Syntax

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret); Unicode (Windows) BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);
int secureblackbox_soapclient_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_soapclient_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);

Default Value

FALSE

Remarks

Enables Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (SOAPClient Class)

Enables or disables TLS session resumption capability.

Syntax

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption); Unicode (Windows) BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);
int secureblackbox_soapclient_gettlsusesessionresumption(void* lpObj);
int secureblackbox_soapclient_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);

Default Value

FALSE

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SOAPClient Class)

The SSL/TLS versions to enable by default.

Syntax

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions); Unicode (Windows) INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);
int secureblackbox_soapclient_gettlsversions(void* lpObj);
int secureblackbox_soapclient_settlsversions(void* lpObj, int iTLSVersions);
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Data Type

Integer

TrustedCertCount Property (SOAPClient Class)

The number of records in the TrustedCert arrays.

Syntax

ANSI (Cross Platform)
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); Unicode (Windows) INT GetTrustedCertCount();
INT SetTrustedCertCount(INT iTrustedCertCount);
int secureblackbox_soapclient_gettrustedcertcount(void* lpObj);
int secureblackbox_soapclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SOAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetTrustedCertBytes(int iTrustedCertIndex, char* &lpTrustedCertBytes, int &lenTrustedCertBytes);

Unicode (Windows)
INT GetTrustedCertBytes(INT iTrustedCertIndex, LPSTR &lpTrustedCertBytes, INT &lenTrustedCertBytes);
int secureblackbox_soapclient_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
QByteArray GetTrustedCertBytes(int iTrustedCertIndex);

Remarks

Returns raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

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

Data Type

Byte Array

TrustedCertHandle Property (SOAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, int64 lTrustedCertHandle); Unicode (Windows) LONG64 GetTrustedCertHandle(INT iTrustedCertIndex);
INT SetTrustedCertHandle(INT iTrustedCertIndex, LONG64 lTrustedCertHandle);
int64 secureblackbox_soapclient_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_soapclient_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Long64

UseDigestAuth Property (SOAPClient Class)

Enables or disables the HTTP Digest authentication.

Syntax

ANSI (Cross Platform)
int GetUseDigestAuth();
int SetUseDigestAuth(int bUseDigestAuth); Unicode (Windows) BOOL GetUseDigestAuth();
INT SetUseDigestAuth(BOOL bUseDigestAuth);
int secureblackbox_soapclient_getusedigestauth(void* lpObj);
int secureblackbox_soapclient_setusedigestauth(void* lpObj, int bUseDigestAuth);
bool GetUseDigestAuth();
int SetUseDigestAuth(bool bUseDigestAuth);

Default Value

FALSE

Remarks

Digest authentication is more advanced than the Basic scheme, as it does not send the username and password in plain text and is immune to replay attacks.

Digest authentication is standardized in RFC 2617.

Data Type

Boolean

UseKerberosAuth Property (SOAPClient Class)

Enables Kerberos authentication mechanism.

Syntax

ANSI (Cross Platform)
int GetUseKerberosAuth();
int SetUseKerberosAuth(int bUseKerberosAuth); Unicode (Windows) BOOL GetUseKerberosAuth();
INT SetUseKerberosAuth(BOOL bUseKerberosAuth);
int secureblackbox_soapclient_getusekerberosauth(void* lpObj);
int secureblackbox_soapclient_setusekerberosauth(void* lpObj, int bUseKerberosAuth);
bool GetUseKerberosAuth();
int SetUseKerberosAuth(bool bUseKerberosAuth);

Default Value

FALSE

Remarks

Set this property to true to enable Kerberos (Negotiate) authentication mechanism.

Data Type

Boolean

UseNTLMAuth Property (SOAPClient Class)

Enables or disables NTLM authentication.

Syntax

ANSI (Cross Platform)
int GetUseNTLMAuth();
int SetUseNTLMAuth(int bUseNTLMAuth); Unicode (Windows) BOOL GetUseNTLMAuth();
INT SetUseNTLMAuth(BOOL bUseNTLMAuth);
int secureblackbox_soapclient_getusentlmauth(void* lpObj);
int secureblackbox_soapclient_setusentlmauth(void* lpObj, int bUseNTLMAuth);
bool GetUseNTLMAuth();
int SetUseNTLMAuth(bool bUseNTLMAuth);

Default Value

FALSE

Remarks

NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.

Data Type

Boolean

Config Method (SOAPClient Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_soapclient_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (SOAPClient Class)

Performs an additional action.

Syntax

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_soapclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insencitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SendMessage Method (SOAPClient Class)

Sends a SOAP message to the server.

Syntax

ANSI (Cross Platform)
int SendMessage(const char* lpszUrl);

Unicode (Windows)
INT SendMessage(LPCWSTR lpszUrl);
int secureblackbox_soapclient_sendmessage(void* lpObj, const char* lpszUrl);
int SendMessage(const QString& qsUrl);

Remarks

The SendMessage() does the following:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendMessageWithAttachments Method (SOAPClient Class)

Sends a SOAP message with attachment(s) to the server.

Syntax

ANSI (Cross Platform)
int SendMessageWithAttachments(const char* lpszUrl, const char* lpszPrimaryMessageId);

Unicode (Windows)
INT SendMessageWithAttachments(LPCWSTR lpszUrl, LPCWSTR lpszPrimaryMessageId);
int secureblackbox_soapclient_sendmessagewithattachments(void* lpObj, const char* lpszUrl, const char* lpszPrimaryMessageId);
int SendMessageWithAttachments(const QString& qsUrl, const QString& qsPrimaryMessageId);

Remarks

This method follows the general pattern used by SendMessage method. It also lets you pass a selection of attachments to the service.

Assign the attachment content to AttachmentBytes, AttachmentFile, or AttachmentStream property. Subscribe to BeforeSendAttachment to pass more than one attachment.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BeforeReceiveAttachment Event (SOAPClient Class)

Marks the start of receiving an attachment.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeReceiveAttachment(SOAPClientBeforeReceiveAttachmentEventParams *e);
typedef struct { int reserved; } SOAPClientBeforeReceiveAttachmentEventParams;
Unicode (Windows) virtual INT FireBeforeReceiveAttachment(SOAPClientBeforeReceiveAttachmentEventParams *e);
typedef struct { INT reserved; } SOAPClientBeforeReceiveAttachmentEventParams;
#define EID_SOAPCLIENT_BEFORERECEIVEATTACHMENT 1

virtual INT SECUREBLACKBOX_CALL FireBeforeReceiveAttachment();
class SOAPClientBeforeReceiveAttachmentEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeReceiveAttachment(SOAPClientBeforeReceiveAttachmentEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireBeforeReceiveAttachment(SOAPClientBeforeReceiveAttachmentEventParams *e) {...}

Remarks

This event fires for every new attachment being received from the service.

Tune up OutputAttachmentBytes, OutputAttachmentFile or OutputAttachmentStream properties inside the event handler to indicate where the attachment content should be saved.

BeforeSendAttachment Event (SOAPClient Class)

Marks the start of sending an attachment.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeSendAttachment(SOAPClientBeforeSendAttachmentEventParams *e);
typedef struct {
int LastAttachment; int reserved; } SOAPClientBeforeSendAttachmentEventParams;
Unicode (Windows) virtual INT FireBeforeSendAttachment(SOAPClientBeforeSendAttachmentEventParams *e);
typedef struct {
BOOL LastAttachment; INT reserved; } SOAPClientBeforeSendAttachmentEventParams;
#define EID_SOAPCLIENT_BEFORESENDATTACHMENT 2

virtual INT SECUREBLACKBOX_CALL FireBeforeSendAttachment(BOOL &bLastAttachment);
class SOAPClientBeforeSendAttachmentEventParams {
public:
  bool LastAttachment();
  void SetLastAttachment(bool bLastAttachment);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeSendAttachment(SOAPClientBeforeSendAttachmentEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireBeforeSendAttachment(SOAPClientBeforeSendAttachmentEventParams *e) {...}

Remarks

Use either AttachmentBytes, AttachmentFile or AttachmentStream properties to pass attachment to the class.

Set LastAttachment parameter to False to indicate that you have more than one attachment to pass.

Cookie Event (SOAPClient Class)

Fired to report a received cookie.

Syntax

Remarks

The CookieText parameter contains the text of the cookie.

DocumentBegin Event (SOAPClient Class)

Marks the start of the incoming HTML document or file.

Syntax

ANSI (Cross Platform)
virtual int FireDocumentBegin(SOAPClientDocumentBeginEventParams *e);
typedef struct { int reserved; } SOAPClientDocumentBeginEventParams;
Unicode (Windows) virtual INT FireDocumentBegin(SOAPClientDocumentBeginEventParams *e);
typedef struct { INT reserved; } SOAPClientDocumentBeginEventParams;
#define EID_SOAPCLIENT_DOCUMENTBEGIN 4

virtual INT SECUREBLACKBOX_CALL FireDocumentBegin();
class SOAPClientDocumentBeginEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DocumentBegin(SOAPClientDocumentBeginEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireDocumentBegin(SOAPClientDocumentBeginEventParams *e) {...}

Remarks

This event is followed by one or more Progress calls. When the document has been received in full, the DocumentEnd event is fired.

DocumentEnd Event (SOAPClient Class)

Marks the successful receipt of the incoming HTML document or file.

Syntax

ANSI (Cross Platform)
virtual int FireDocumentEnd(SOAPClientDocumentEndEventParams *e);
typedef struct { int reserved; } SOAPClientDocumentEndEventParams;
Unicode (Windows) virtual INT FireDocumentEnd(SOAPClientDocumentEndEventParams *e);
typedef struct { INT reserved; } SOAPClientDocumentEndEventParams;
#define EID_SOAPCLIENT_DOCUMENTEND 5

virtual INT SECUREBLACKBOX_CALL FireDocumentEnd();
class SOAPClientDocumentEndEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DocumentEnd(SOAPClientDocumentEndEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireDocumentEnd(SOAPClientDocumentEndEventParams *e) {...}

Remarks

This event fires when the document has been received in full.

Error Event (SOAPClient Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(SOAPClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SOAPClientErrorEventParams;
Unicode (Windows) virtual INT FireError(SOAPClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SOAPClientErrorEventParams;
#define EID_SOAPCLIENT_ERROR 6

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SOAPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(SOAPClientErrorEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireError(SOAPClientErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during message processing.

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

ExternalSign Event (SOAPClient Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

ANSI (Cross Platform)
virtual int FireExternalSign(SOAPClientExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } SOAPClientExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(SOAPClientExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } SOAPClientExternalSignEventParams;
#define EID_SOAPCLIENT_EXTERNALSIGN 7

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class SOAPClientExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ExternalSign(SOAPClientExternalSignEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireExternalSign(SOAPClientExternalSignEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

HeadersPrepared Event (SOAPClient Class)

Fires when the request headers have been formed and are about to be sent to the server.

Syntax

ANSI (Cross Platform)
virtual int FireHeadersPrepared(SOAPClientHeadersPreparedEventParams *e);
typedef struct { int reserved; } SOAPClientHeadersPreparedEventParams;
Unicode (Windows) virtual INT FireHeadersPrepared(SOAPClientHeadersPreparedEventParams *e);
typedef struct { INT reserved; } SOAPClientHeadersPreparedEventParams;
#define EID_SOAPCLIENT_HEADERSPREPARED 8

virtual INT SECUREBLACKBOX_CALL FireHeadersPrepared();
class SOAPClientHeadersPreparedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void HeadersPrepared(SOAPClientHeadersPreparedEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireHeadersPrepared(SOAPClientHeadersPreparedEventParams *e) {...}

Remarks

The prepared headers are available in RequestHeaders property. This event provides you the last chance to review/alter them.

HeadersReceived Event (SOAPClient Class)

Fires when the HTTP response headers have just been received from the server.

Syntax

ANSI (Cross Platform)
virtual int FireHeadersReceived(SOAPClientHeadersReceivedEventParams *e);
typedef struct { int reserved; } SOAPClientHeadersReceivedEventParams;
Unicode (Windows) virtual INT FireHeadersReceived(SOAPClientHeadersReceivedEventParams *e);
typedef struct { INT reserved; } SOAPClientHeadersReceivedEventParams;
#define EID_SOAPCLIENT_HEADERSRECEIVED 9

virtual INT SECUREBLACKBOX_CALL FireHeadersReceived();
class SOAPClientHeadersReceivedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void HeadersReceived(SOAPClientHeadersReceivedEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireHeadersReceived(SOAPClientHeadersReceivedEventParams *e) {...}

Remarks

The received headers are available via the ResponseHeaders property.

Notification Event (SOAPClient Class)

This event notifies the application about an underlying control flow event.

Syntax

ANSI (Cross Platform)
virtual int FireNotification(SOAPClientNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } SOAPClientNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(SOAPClientNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } SOAPClientNotificationEventParams;
#define EID_SOAPCLIENT_NOTIFICATION 10

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class SOAPClientNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Notification(SOAPClientNotificationEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireNotification(SOAPClientNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (SOAPClient Class)

Fires periodically during the data transfer.

Syntax

ANSI (Cross Platform)
virtual int FireProgress(SOAPClientProgressEventParams *e);
typedef struct {
int64 Total;
int64 Current;
int Cancel; int reserved; } SOAPClientProgressEventParams;
Unicode (Windows) virtual INT FireProgress(SOAPClientProgressEventParams *e);
typedef struct {
LONG64 Total;
LONG64 Current;
BOOL Cancel; INT reserved; } SOAPClientProgressEventParams;
#define EID_SOAPCLIENT_PROGRESS 11

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);
class SOAPClientProgressEventParams {
public:
  qint64 Total();

  qint64 Current();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Progress(SOAPClientProgressEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireProgress(SOAPClientProgressEventParams *e) {...}

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

Redirection Event (SOAPClient Class)

Fires when the server suggests a redirect.

Syntax

ANSI (Cross Platform)
virtual int FireRedirection(SOAPClientRedirectionEventParams *e);
typedef struct {
const char *OldURL;
char *NewURL;
int AllowRedirection; int reserved; } SOAPClientRedirectionEventParams;
Unicode (Windows) virtual INT FireRedirection(SOAPClientRedirectionEventParams *e);
typedef struct {
LPCWSTR OldURL;
LPWSTR NewURL;
BOOL AllowRedirection; INT reserved; } SOAPClientRedirectionEventParams;
#define EID_SOAPCLIENT_REDIRECTION 12

virtual INT SECUREBLACKBOX_CALL FireRedirection(LPSTR &lpszOldURL, LPSTR &lpszNewURL, BOOL &bAllowRedirection);
class SOAPClientRedirectionEventParams {
public:
  const QString &OldURL();

  const QString &NewURL();
  void SetNewURL(const QString &qsNewURL);

  bool AllowRedirection();
  void SetAllowRedirection(bool bAllowRedirection);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Redirection(SOAPClientRedirectionEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireRedirection(SOAPClientRedirectionEventParams *e) {...}

Remarks

This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.

Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.

TLSCertNeeded Event (SOAPClient Class)

Fires when a remote TLS party requests a client certificate.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertNeeded(SOAPClientTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } SOAPClientTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(SOAPClientTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } SOAPClientTLSCertNeededEventParams;
#define EID_SOAPCLIENT_TLSCERTNEEDED 13

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class SOAPClientTLSCertNeededEventParams {
public:
  const QString &Host();

  const QString &CANames();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSCertNeeded(SOAPClientTLSCertNeededEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireTLSCertNeeded(SOAPClientTLSCertNeededEventParams *e) {...}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (SOAPClient Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertValidate(SOAPClientTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } SOAPClientTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(SOAPClientTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } SOAPClientTLSCertValidateEventParams;
#define EID_SOAPCLIENT_TLSCERTVALIDATE 14

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class SOAPClientTLSCertValidateEventParams {
public:
  const QString &ServerHost();

  const QString &ServerIP();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSCertValidate(SOAPClientTLSCertValidateEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireTLSCertValidate(SOAPClientTLSCertValidateEventParams *e) {...}

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.

TLSEstablished Event (SOAPClient Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

ANSI (Cross Platform)
virtual int FireTLSEstablished(SOAPClientTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } SOAPClientTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(SOAPClientTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } SOAPClientTLSEstablishedEventParams;
#define EID_SOAPCLIENT_TLSESTABLISHED 15

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class SOAPClientTLSEstablishedEventParams {
public:
  const QString &Host();

  const QString &Version();

  const QString &Ciphersuite();

  const QByteArray &ConnectionId();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSEstablished(SOAPClientTLSEstablishedEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireTLSEstablished(SOAPClientTLSEstablishedEventParams *e) {...}

Remarks

The class uses this event to notify the application about successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (SOAPClient Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

ANSI (Cross Platform)
virtual int FireTLSHandshake(SOAPClientTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } SOAPClientTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(SOAPClientTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } SOAPClientTLSHandshakeEventParams;
#define EID_SOAPCLIENT_TLSHANDSHAKE 16

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class SOAPClientTLSHandshakeEventParams {
public:
  const QString &Host();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSHandshake(SOAPClientTLSHandshakeEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireTLSHandshake(SOAPClientTLSHandshakeEventParams *e) {...}

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.

TLSPSK Event (SOAPClient Class)

Notifies the application about the PSK key exchange.

Syntax

ANSI (Cross Platform)
virtual int FireTLSPSK(SOAPClientTLSPSKEventParams *e);
typedef struct {
const char *Host;
const char *Hint; int reserved; } SOAPClientTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(SOAPClientTLSPSKEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Hint; INT reserved; } SOAPClientTLSPSKEventParams;
#define EID_SOAPCLIENT_TLSPSK 17

virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LPSTR &lpszHost, LPSTR &lpszHint);
class SOAPClientTLSPSKEventParams {
public:
  const QString &Host();

  const QString &Hint();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSPSK(SOAPClientTLSPSKEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireTLSPSK(SOAPClientTLSPSKEventParams *e) {...}

Remarks

The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (SOAPClient Class)

Reports the graceful closure of a TLS connection.

Syntax

ANSI (Cross Platform)
virtual int FireTLSShutdown(SOAPClientTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } SOAPClientTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(SOAPClientTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } SOAPClientTLSShutdownEventParams;
#define EID_SOAPCLIENT_TLSSHUTDOWN 18

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class SOAPClientTLSShutdownEventParams {
public:
  const QString &Host();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSShutdown(SOAPClientTLSShutdownEventParams *e);
// Or, subclass SOAPClient and override this emitter function. virtual int FireTLSShutdown(SOAPClientTLSShutdownEventParams *e) {...}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (SOAPClient Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

HTTPClient Config Settings

AttachmentContentDescription:   Specifies attachment content description.

Specifies content description for the attachment.

AttachmentContentId:   Specifies attachment content Id.

Specifies content Id for the attachment.

AttachmentContentType:   Specifies attachment content type.

Specifies content type for the attachment.

AttachmentFilename:   Specifies attachment filename.

Specifies filename for the attachment.

CacheStreamOutput:   Tells the component whether to cache stream- and file-bound responses in the component.

Set this property to true to enable caching of potentially long responses obtained with GetFile and GetStream methods. If the response is cached, it will be available via OutputBytes and OutputString properties after the request is completed, but may occupy extra memory resources.

FaultActor[Index]:   Specifies who caused the fault.

Use this property to get the URI associated with the actor (SOAP node) that caused the fault. In RPC-style messaging, the actor is the URI of the Web service.

FaultCode[Index]:   Specifies the error code.

Use this property to get the standard code that provides more information about the fault. A set of code values is predefined by the SOAP specification. This set of fault code values can be extended by the application.

FaultCount:   The number of faults.

Returns the number of the faults obtained.

FaultDetail[Index]:   Contains application-specific error information.

Use this property to get the application-specific information, such as the exception that was thrown. This element can be an XML structure or plain text.

FaultString[Index]:   Specifies a human-readable description of fault.

Use this property to get the human-readable description of the error.

FaultXML[Index]:   Specifies the XML content of the fault.

Use this property to get the XML content of the fault.

ForceNTLMAuth:   Activates and enforces NTLM authentication.

Set this property to True to force NTLM (Windows Integrated) authentication.

IgnoreSystemTrust:   Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.

IgnoreUnknownTransferEncodings:   All incoming responses with unknown transfer encodings are ignored if this property is true.

All incoming responses with unknown transfer encodings are ignored if this property is true.

MaxRedirections:   The maximum number of HTTP redirects.

Specifies the maximum number of HTTP redirects. Value 0 prevents any redirections, and -1 allows unlimited redirections.

PersistentAuthHeader:   Whether to resend NTLM negotiation on every request.

Specifies whether to resend NTLM negotiation on every request.

RelatedStartInfo:   Specifies Start-Info parameter.

Specifies additional information required for unpacking or processing of the content. It is optional Start-Info parameter of the Multipart/Related media type.

RelatedType:   Specifies media type/subtype.

Specifies media type/subtype of message's content. Use this property to override default media type. It is Type parameter of the Multipart/Related media type.

RequestCompressionGZip:   Ask server to use GZip compression.

Ask server to use GZip compression.

RequestCompressionLevel:   Ask server to use the specified compression level.

Ask server to use the specified compression level.

SendBufferSize:   Size of send buffer in bytes.

The size of blocks used to send data to the server.

SkipInputProcessing:   Whether to skip input processing.

Set this property to True to enforce the class to send input data as-is.

SkipOutputParsing:   Whether to skip output parsing.

Set this property to True to enforce the class to not to parse the output. In this case, SOAPResponseType property value will be either srtUnknown or srtBinary, and OperationResponse* and Fault* properties will not be set.

SOAPPrefix:   Specifies the signature prefix.

Specifies the prefix for the SOAPMessage elements.

Default value is "". In this case no prefix will be used.

Special values:

"#default" or ""indicates that the prefix will be omitted.
"#auto"indicates that the prefix will be auto-detected based on the parent nodes.

SuppressRedirectionContent:   Whether to suppress the redirection content.

If this property is set to True, the redirection content will be silently suppressed by the class. Otherwise the message containing a redirection code will be processed as usual, the Redirection event will be fired, and the data will be written to OutputString or OutputBytes.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TolerateMinorChainIssues:   Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

  • CA, revocation source, TLS key usage requirements are not mandated
  • Violation of OCSP issuer requirements are ignored
  • AuthorityKeyID extension in CRL and certificate issuing CAs are ignored (helps with incorrectly renewed certificates)
  • Basic constraints and name constraints of CA certificates are ignored
  • Some weaker algorithms are tolerated
Use100Continue:   Whether to use 100-continue for POST and PUT commands.

Set this property to True to use the 100-continue approach for POST and PUT commands. In this approach, prior to sending the request body, the client sends a request message asking the server whether it is willing to accept the request body. The request body is sent only if the server accepts it.

UseCompression:   Whether to use GZip compression.

Use this property to tell the server that it can transfer GZIPped data (if the server supports it).

UseMicrosoftCTL:   Enables or disables automatic use of Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSOAPAction:   Whether to use SOAP Action.

Set this property to False to disable adding SOAPAction/action header field.

UseSystemCertificates:   Enables or disables the use of the system certificates.

Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SOAPClient Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SOAPClient Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
19922945   Unsupported keep-alive policy (SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY) 
33554689   Unexpected HTTP status code (SB_ERROR_SOAP_CLIENT_UNEXPECTED_HTTP_STATUS_CODE)
33554690   SOAP service failed (SB_ERROR_SOAP_CLIENT_SERVICE_FAILED)