WebSocketClient Class

Properties   Methods   Events   Config Settings   Errors  

The WebSocketClient class provides the client-side functionality of the WebSocket protocol.

Syntax

WebSocketClient

Remarks

Use this component to set up secure connections from your application with a WebSocket server.

Property List

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

Method List

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

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.

Config Settings

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

BlockedCertCount Property (WebSocketClient Class)

The number of records in the BlockedCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Unicode (Windows)
INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);

int secureblackbox_websocketclient_getblockedcertcount(void* lpObj);
int secureblackbox_websocketclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (WebSocketClient Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);

int secureblackbox_websocketclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns the 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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

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_websocketclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_websocketclient_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.

 
 Copy
  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 (WebSocketClient Class)

The number of records in the ClientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Unicode (Windows)
INT GetClientCertCount();
INT SetClientCertCount(INT iClientCertCount);

int secureblackbox_websocketclient_getclientcertcount(void* lpObj);
int secureblackbox_websocketclient_setclientcertcount(void* lpObj, int iClientCertCount);

int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientCertBytes
• ClientCertHandle

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

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (WebSocketClient Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetClientCertBytes(INT iClientCertIndex, LPSTR &lpClientCertBytes, INT &lenClientCertBytes);

int secureblackbox_websocketclient_getclientcertbytes(void* lpObj, int clientcertindex, char** lpClientCertBytes, int* lenClientCertBytes);

QByteArray GetClientCertBytes(int iClientCertIndex);

Remarks

Returns the 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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

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_websocketclient_getclientcerthandle(void* lpObj, int clientcertindex);
int secureblackbox_websocketclient_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.

 
 Copy
  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

Connected Property (WebSocketClient Class)

Indicates whether the connection is active.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int secureblackbox_websocketclient_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

Use this property to check if the connection is alive.

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

Data Type

Boolean

ConnInfoAEADCipher Property (WebSocketClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoAEADCipher();

Unicode (Windows)
BOOL GetConnInfoAEADCipher();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

The details of a certificate chain validation outcome.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationDetails();

Unicode (Windows)
INT GetConnInfoChainValidationDetails();

int secureblackbox_websocketclient_getconninfochainvalidationdetails(void* lpObj);

int GetConnInfoChainValidationDetails();

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

Data Type

Integer

ConnInfoChainValidationResult Property (WebSocketClient Class)

The outcome of a certificate chain validation routine.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationResult();

Unicode (Windows)
INT GetConnInfoChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_websocketclient_getconninfochainvalidationresult(void* lpObj);

int GetConnInfoChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

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 (WebSocketClient Class)

The cipher suite employed by this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoCiphersuite();

Unicode (Windows)
LPWSTR GetConnInfoCiphersuite();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

Specifies whether client authentication was performed during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthenticated();

Unicode (Windows)
BOOL GetConnInfoClientAuthenticated();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

Specifies whether client authentication was requested during this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthRequested();

Unicode (Windows)
BOOL GetConnInfoClientAuthRequested();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

Indicates whether the connection has been established fully.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoConnectionEstablished();

Unicode (Windows)
BOOL GetConnInfoConnectionEstablished();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

The unique identifier assigned to this connection.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetConnInfoConnectionID(LPSTR &lpConnInfoConnectionID, INT &lenConnInfoConnectionID);

int secureblackbox_websocketclient_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 (WebSocketClient Class)

The digest algorithm used in a TLS-enabled connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoDigestAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoDigestAlgorithm();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithm();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoExportable();

Unicode (Windows)
BOOL GetConnInfoExportable();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKeyExchangeAlgorithm();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoKeyExchangeKeyBits();

Unicode (Windows)
INT GetConnInfoKeyExchangeKeyBits();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

The elliptic curve used in this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoNamedECCurve();

Unicode (Windows)
LPWSTR GetConnInfoNamedECCurve();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPFSCipher();

Unicode (Windows)
BOOL GetConnInfoPFSCipher();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoPreSharedIdentityHint();

Unicode (Windows)
LPWSTR GetConnInfoPreSharedIdentityHint();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

The length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPublicKeyBits();

Unicode (Windows)
INT GetConnInfoPublicKeyBits();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoResumedSession();

Unicode (Windows)
BOOL GetConnInfoResumedSession();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSecureConnection();

Unicode (Windows)
BOOL GetConnInfoSecureConnection();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoServerAuthenticated();

Unicode (Windows)
BOOL GetConnInfoServerAuthenticated();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

The signature algorithm used in a TLS handshake.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoSignatureAlgorithm();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

The block size of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricBlockSize();

Unicode (Windows)
INT GetConnInfoSymmetricBlockSize();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

The key length of the symmetric algorithm used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricKeyBits();

Unicode (Windows)
INT GetConnInfoSymmetricKeyBits();

int secureblackbox_websocketclient_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 (WebSocketClient Class)

The total number of bytes received over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();

int64 secureblackbox_websocketclient_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 (WebSocketClient Class)

The total number of bytes sent over this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();

int64 secureblackbox_websocketclient_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 (WebSocketClient Class)

Contains the server certificate's chain validation log.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoValidationLog();

Unicode (Windows)
LPWSTR GetConnInfoValidationLog();

char* secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoVersion();

Unicode (Windows)
LPWSTR GetConnInfoVersion();

char* secureblackbox_websocketclient_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

ExternalCryptoAsyncDocumentID Property (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_websocketclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_websocketclient_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 the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_websocketclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_websocketclient_getexternalcryptodata(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_websocketclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_websocketclient_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 the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (WebSocketClient Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_websocketclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_websocketclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_websocketclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_websocketclient_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 an extra protection layer for the protocol and diminishes the risk of the 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:

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (WebSocketClient Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_websocketclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_websocketclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_websocketclient_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:

Data Type

Integer

ExternalCryptoMode Property (WebSocketClient Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_websocketclient_getexternalcryptomode(void* lpObj);
int secureblackbox_websocketclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_websocketclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_websocketclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (WebSocketClient Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_websocketclient_getfipsmode(void* lpObj);
int secureblackbox_websocketclient_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

KnownCertCount Property (WebSocketClient Class)

The number of records in the KnownCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_websocketclient_getknowncertcount(void* lpObj);
int secureblackbox_websocketclient_setknowncertcount(void* lpObj, int iKnownCertCount);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (WebSocketClient Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

int secureblackbox_websocketclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns the 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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

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_websocketclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_websocketclient_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.

 
 Copy
  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 (WebSocketClient Class)

The number of records in the KnownCRL arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Unicode (Windows)
INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);

int secureblackbox_websocketclient_getknowncrlcount(void* lpObj);
int secureblackbox_websocketclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (WebSocketClient Class)

Returns the raw CRL data in DER format.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);

int secureblackbox_websocketclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns the 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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

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_websocketclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_websocketclient_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.

 
 Copy
  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 (WebSocketClient Class)

The number of records in the KnownOCSP arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Unicode (Windows)
INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);

int secureblackbox_websocketclient_getknownocspcount(void* lpObj);
int secureblackbox_websocketclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (WebSocketClient Class)

A buffer containing the raw OCSP response data.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);

int secureblackbox_websocketclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

A buffer containing the 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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

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_websocketclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_websocketclient_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.

 
 Copy
  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

ProxyAddress Property (WebSocketClient Class)

The IP address of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress);

Unicode (Windows)
LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);

char* secureblackbox_websocketclient_getproxyaddress(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

The authentication type used by the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Unicode (Windows)
INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

int secureblackbox_websocketclient_getproxyauthentication(void* lpObj);
int secureblackbox_websocketclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (WebSocketClient Class)

The password to authenticate to the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* secureblackbox_websocketclient_getproxypassword(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

The port on the proxy server to connect to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int secureblackbox_websocketclient_getproxyport(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

The type of the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Unicode (Windows)
INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

int secureblackbox_websocketclient_getproxyproxytype(void* lpObj);
int secureblackbox_websocketclient_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.

Data Type

Integer

ProxyRequestHeaders Property (WebSocketClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders);

Unicode (Windows)
LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);

char* secureblackbox_websocketclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody);

Unicode (Windows)
LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);

char* secureblackbox_websocketclient_getproxyresponsebody(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders);

Unicode (Windows)
LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);

char* secureblackbox_websocketclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6);

Unicode (Windows)
BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);

int secureblackbox_websocketclient_getproxyuseipv6(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Enables or disables proxy-driven connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy);

Unicode (Windows)
BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);

int secureblackbox_websocketclient_getproxyuseproxy(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Specifies the username credential for proxy authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername);

Unicode (Windows)
LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);

char* secureblackbox_websocketclient_getproxyusername(void* lpObj);
int secureblackbox_websocketclient_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

ReqParamsAccept Property (WebSocketClient Class)

Specifies the Accept header property of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAccept();
int SetReqParamsAccept(const char* lpszReqParamsAccept);

Unicode (Windows)
LPWSTR GetReqParamsAccept();
INT SetReqParamsAccept(LPCWSTR lpszReqParamsAccept);

char* secureblackbox_websocketclient_getreqparamsaccept(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAcceptCharset();
int SetReqParamsAcceptCharset(const char* lpszReqParamsAcceptCharset);

Unicode (Windows)
LPWSTR GetReqParamsAcceptCharset();
INT SetReqParamsAcceptCharset(LPCWSTR lpszReqParamsAcceptCharset);

char* secureblackbox_websocketclient_getreqparamsacceptcharset(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAcceptLanguage();
int SetReqParamsAcceptLanguage(const char* lpszReqParamsAcceptLanguage);

Unicode (Windows)
LPWSTR GetReqParamsAcceptLanguage();
INT SetReqParamsAcceptLanguage(LPCWSTR lpszReqParamsAcceptLanguage);

char* secureblackbox_websocketclient_getreqparamsacceptlanguage(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsAcceptRangeEnd();
int SetReqParamsAcceptRangeEnd(int64 lReqParamsAcceptRangeEnd);

Unicode (Windows)
LONG64 GetReqParamsAcceptRangeEnd();
INT SetReqParamsAcceptRangeEnd(LONG64 lReqParamsAcceptRangeEnd);

int64 secureblackbox_websocketclient_getreqparamsacceptrangeend(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsAcceptRangeStart();
int SetReqParamsAcceptRangeStart(int64 lReqParamsAcceptRangeStart);

Unicode (Windows)
LONG64 GetReqParamsAcceptRangeStart();
INT SetReqParamsAcceptRangeStart(LONG64 lReqParamsAcceptRangeStart);

int64 secureblackbox_websocketclient_getreqparamsacceptrangestart(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Specifies the Authorization header of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsAuthorization();
int SetReqParamsAuthorization(const char* lpszReqParamsAuthorization);

Unicode (Windows)
LPWSTR GetReqParamsAuthorization();
INT SetReqParamsAuthorization(LPCWSTR lpszReqParamsAuthorization);

char* secureblackbox_websocketclient_getreqparamsauthorization(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsConnection();
int SetReqParamsConnection(const char* lpszReqParamsConnection);

Unicode (Windows)
LPWSTR GetReqParamsConnection();
INT SetReqParamsConnection(LPCWSTR lpszReqParamsConnection);

char* secureblackbox_websocketclient_getreqparamsconnection(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentLength();
int SetReqParamsContentLength(int64 lReqParamsContentLength);

Unicode (Windows)
LONG64 GetReqParamsContentLength();
INT SetReqParamsContentLength(LONG64 lReqParamsContentLength);

int64 secureblackbox_websocketclient_getreqparamscontentlength(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentRangeEnd();
int SetReqParamsContentRangeEnd(int64 lReqParamsContentRangeEnd);

Unicode (Windows)
LONG64 GetReqParamsContentRangeEnd();
INT SetReqParamsContentRangeEnd(LONG64 lReqParamsContentRangeEnd);

int64 secureblackbox_websocketclient_getreqparamscontentrangeend(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentRangeFullSize();
int SetReqParamsContentRangeFullSize(int64 lReqParamsContentRangeFullSize);

Unicode (Windows)
LONG64 GetReqParamsContentRangeFullSize();
INT SetReqParamsContentRangeFullSize(LONG64 lReqParamsContentRangeFullSize);

int64 secureblackbox_websocketclient_getreqparamscontentrangefullsize(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReqParamsContentRangeStart();
int SetReqParamsContentRangeStart(int64 lReqParamsContentRangeStart);

Unicode (Windows)
LONG64 GetReqParamsContentRangeStart();
INT SetReqParamsContentRangeStart(LONG64 lReqParamsContentRangeStart);

int64 secureblackbox_websocketclient_getreqparamscontentrangestart(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

The Content-Type header property of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsContentType();
int SetReqParamsContentType(const char* lpszReqParamsContentType);

Unicode (Windows)
LPWSTR GetReqParamsContentType();
INT SetReqParamsContentType(LPCWSTR lpszReqParamsContentType);

char* secureblackbox_websocketclient_getreqparamscontenttype(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsCookie();
int SetReqParamsCookie(const char* lpszReqParamsCookie);

Unicode (Windows)
LPWSTR GetReqParamsCookie();
INT SetReqParamsCookie(LPCWSTR lpszReqParamsCookie);

char* secureblackbox_websocketclient_getreqparamscookie(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsCustomHeaders();
int SetReqParamsCustomHeaders(const char* lpszReqParamsCustomHeaders);

Unicode (Windows)
LPWSTR GetReqParamsCustomHeaders();
INT SetReqParamsCustomHeaders(LPCWSTR lpszReqParamsCustomHeaders);

char* secureblackbox_websocketclient_getreqparamscustomheaders(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

The date and time of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsDate();
int SetReqParamsDate(const char* lpszReqParamsDate);

Unicode (Windows)
LPWSTR GetReqParamsDate();
INT SetReqParamsDate(LPCWSTR lpszReqParamsDate);

char* secureblackbox_websocketclient_getreqparamsdate(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Contains the From header property of the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsFrom();
int SetReqParamsFrom(const char* lpszReqParamsFrom);

Unicode (Windows)
LPWSTR GetReqParamsFrom();
INT SetReqParamsFrom(LPCWSTR lpszReqParamsFrom);

char* secureblackbox_websocketclient_getreqparamsfrom(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsHost();
int SetReqParamsHost(const char* lpszReqParamsHost);

Unicode (Windows)
LPWSTR GetReqParamsHost();
INT SetReqParamsHost(LPCWSTR lpszReqParamsHost);

char* secureblackbox_websocketclient_getreqparamshost(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Specifies the version of HTTP protocol to use: 1.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReqParamsHTTPVersion();
int SetReqParamsHTTPVersion(int iReqParamsHTTPVersion);

Unicode (Windows)
INT GetReqParamsHTTPVersion();
INT SetReqParamsHTTPVersion(INT iReqParamsHTTPVersion);

CHV_HTTP10(0), 
CHV_HTTP11(1)

int secureblackbox_websocketclient_getreqparamshttpversion(void* lpObj);
int secureblackbox_websocketclient_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.

This property is not available at design time.

Data Type

Integer

ReqParamsIfMatch Property (WebSocketClient Class)

Contains the If-Match request header property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsIfMatch();
int SetReqParamsIfMatch(const char* lpszReqParamsIfMatch);

Unicode (Windows)
LPWSTR GetReqParamsIfMatch();
INT SetReqParamsIfMatch(LPCWSTR lpszReqParamsIfMatch);

char* secureblackbox_websocketclient_getreqparamsifmatch(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Contains the If-Modified-Since request header property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsIfModifiedSince();
int SetReqParamsIfModifiedSince(const char* lpszReqParamsIfModifiedSince);

Unicode (Windows)
LPWSTR GetReqParamsIfModifiedSince();
INT SetReqParamsIfModifiedSince(LPCWSTR lpszReqParamsIfModifiedSince);

char* secureblackbox_websocketclient_getreqparamsifmodifiedsince(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Contains the If-None-Match request header property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsIfNoneMatch();
int SetReqParamsIfNoneMatch(const char* lpszReqParamsIfNoneMatch);

Unicode (Windows)
LPWSTR GetReqParamsIfNoneMatch();
INT SetReqParamsIfNoneMatch(LPCWSTR lpszReqParamsIfNoneMatch);

char* secureblackbox_websocketclient_getreqparamsifnonematch(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Contains the If-Unmodified-Since request header property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsIfUnmodifiedSince();
int SetReqParamsIfUnmodifiedSince(const char* lpszReqParamsIfUnmodifiedSince);

Unicode (Windows)
LPWSTR GetReqParamsIfUnmodifiedSince();
INT SetReqParamsIfUnmodifiedSince(LPCWSTR lpszReqParamsIfUnmodifiedSince);

char* secureblackbox_websocketclient_getreqparamsifunmodifiedsince(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

Assign this property with the user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsPassword();
int SetReqParamsPassword(const char* lpszReqParamsPassword);

Unicode (Windows)
LPWSTR GetReqParamsPassword();
INT SetReqParamsPassword(LPCWSTR lpszReqParamsPassword);

char* secureblackbox_websocketclient_getreqparamspassword(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient 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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsReferer();
int SetReqParamsReferer(const char* lpszReqParamsReferer);

Unicode (Windows)
LPWSTR GetReqParamsReferer();
INT SetReqParamsReferer(LPCWSTR lpszReqParamsReferer);

char* secureblackbox_websocketclient_getreqparamsreferer(void* lpObj);
int secureblackbox_websocketclient_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 (WebSocketClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReqParamsUserAgent();
int SetReqParamsUserAgent(const char* lpszReqParamsUserAgent);

Unicode (Windows)
LPWSTR GetReqParamsUserAgent();
INT SetReqParamsUserAgent(LPCWSTR lpszReqParamsUserAgent);

char* secureblackbox_websocketclient_getreqparamsuseragent(void* lpObj);
int secureblackbox_websocketclient_setreqparamsuseragent(void* lpObj, const char* lpszReqParamsUserAgent);

QString GetReqParamsUserAgent();
int SetReqParamsUserAgent(QString qsReqParamsUserAgent);

Default Value

""