SOAP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SOAP

Remarks

The SOAP Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

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

The class uses HTTP to communicate with SOAP servers, and an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP Method and MethodURI, as well as optional parameters in the Params properties. Then set the target URL and call the SendRequest method.

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

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

The class may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket. The corresponding SOAP packet will be stored in the SOAPPacket property. Offline mode is important in cases where the underlying SOAP transport is not HTTP, but another mechanism (e.g. SMTP and POP for email).

By providing direct access to the SOAP packet in offline mode, the class allows for possible extension and full control over the SOAPPacket. The SendPacket method may then be used to send the custom-created SOAPPacket to the destination URL.

Property List

The following is the full list of the properties of the 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.

Accept Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccept();
int SetAccept(const char* lpszAccept);

Unicode (Windows)
LPWSTR GetAccept();
INT SetAccept(LPCWSTR lpszAccept);

char* ipworksssl_soap_getaccept(void* lpObj);
int ipworksssl_soap_setaccept(void* lpObj, const char* lpszAccept);

QString GetAccept();
int SetAccept(QString qsAccept);

Default Value

""

Remarks

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

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

Data Type

String

ActionURI Property (SOAP Class)

The value of the SOAP-Action header.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetActionURI();
int SetActionURI(const char* lpszActionURI);

Unicode (Windows)
LPWSTR GetActionURI();
INT SetActionURI(LPCWSTR lpszActionURI);

char* ipworksssl_soap_getactionuri(void* lpObj);
int ipworksssl_soap_setactionuri(void* lpObj, const char* lpszActionURI);

QString GetActionURI();
int SetActionURI(QString qsActionURI);

Default Value

""

Remarks

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

Data Type

String

Authorization Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* ipworksssl_soap_getauthorization(void* lpObj);
int ipworksssl_soap_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

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

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

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

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

Data Type

String

AuthScheme Property (SOAP Class)

The authentication scheme to use when server authentication is required.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Unicode (Windows)
INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5), 
AUTH_OAUTH(6)

int ipworksssl_soap_getauthscheme(void* lpObj);
int ipworksssl_soap_setauthscheme(void* lpObj, int iAuthScheme);

int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

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

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

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

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

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

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

Data Type

Integer

Connected Property (SOAP Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworksssl_soap_getconnected(void* lpObj);
int ipworksssl_soap_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

ContentType Property (SOAP Class)

Content type for SOAP request data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentType();
int SetContentType(const char* lpszContentType);

Unicode (Windows)
LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);

char* ipworksssl_soap_getcontenttype(void* lpObj);
int ipworksssl_soap_setcontenttype(void* lpObj, const char* lpszContentType);

QString GetContentType();
int SetContentType(QString qsContentType);

Default Value

"text/xml"

Remarks

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

This property is not available at design time.

Data Type

String

CookieCount Property (SOAP Class)

The number of records in the Cookie arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieCount();
int SetCookieCount(int iCookieCount);

Unicode (Windows)
INT GetCookieCount();
INT SetCookieCount(INT iCookieCount);

int ipworksssl_soap_getcookiecount(void* lpObj);
int ipworksssl_soap_setcookiecount(void* lpObj, int iCookieCount);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (SOAP Class)

This is the domain of a received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieDomain(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);

char* ipworksssl_soap_getcookiedomain(void* lpObj, int cookieindex);

QString GetCookieDomain(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieExpiration Property (SOAP Class)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieExpiration(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);

char* ipworksssl_soap_getcookieexpiration(void* lpObj, int cookieindex);

QString GetCookieExpiration(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieName Property (SOAP Class)

This property, contains the name of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, const char* lpszCookieName);

Unicode (Windows)
LPWSTR GetCookieName(INT iCookieIndex);
INT SetCookieName(INT iCookieIndex, LPCWSTR lpszCookieName);

char* ipworksssl_soap_getcookiename(void* lpObj, int cookieindex);
int ipworksssl_soap_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

Default Value

""

Remarks

This property, contains the name of the cookie.

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

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

This property is not available at design time.

Data Type

String

CookiePath Property (SOAP Class)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookiePath(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);

char* ipworksssl_soap_getcookiepath(void* lpObj, int cookieindex);

QString GetCookiePath(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieSecure Property (SOAP Class)

This property contains the security flag of the received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieSecure(int iCookieIndex);

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);

int ipworksssl_soap_getcookiesecure(void* lpObj, int cookieindex);

bool GetCookieSecure(int iCookieIndex);

Default Value

FALSE

Remarks

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

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

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

Data Type

Boolean

CookieValue Property (SOAP Class)

This property contains the value of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, const char* lpszCookieValue);

Unicode (Windows)
LPWSTR GetCookieValue(INT iCookieIndex);
INT SetCookieValue(INT iCookieIndex, LPCWSTR lpszCookieValue);

char* ipworksssl_soap_getcookievalue(void* lpObj, int cookieindex);
int ipworksssl_soap_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Default Value

""

Remarks

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

The SetCookie event provides the cookies set by the server.

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

This property is not available at design time.

Data Type

String

FaultActor Property (SOAP Class)

Actor of any faults returned by the SOAP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFaultActor();

Unicode (Windows)
LPWSTR GetFaultActor();

char* ipworksssl_soap_getfaultactor(void* lpObj);

QString GetFaultActor();

Default Value

""

Remarks

FaultCode and FaultString provide the corresponding fault code and description.

This property is read-only.

Data Type

String

FaultCode Property (SOAP Class)

Code of any faults returned by the SOAP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFaultCode();

Unicode (Windows)
LPWSTR GetFaultCode();

char* ipworksssl_soap_getfaultcode(void* lpObj);

QString GetFaultCode();

Default Value

""

Remarks

FaultString and FaultActor provide the corresponding fault description and actor.

This property is read-only.

Data Type

String

FaultString Property (SOAP Class)

Textual description of any faults returned by the SOAP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFaultString();

Unicode (Windows)
LPWSTR GetFaultString();

char* ipworksssl_soap_getfaultstring(void* lpObj);

QString GetFaultString();

Default Value

""

Remarks

FaultCode and FaultActor provide the corresponding fault code and actor.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (SOAP Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksssl_soap_getfirewallautodetect(void* lpObj);
int ipworksssl_soap_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (SOAP Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksssl_soap_getfirewalltype(void* lpObj);
int ipworksssl_soap_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SOAP Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksssl_soap_getfirewallhost(void* lpObj);
int ipworksssl_soap_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (SOAP Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksssl_soap_getfirewallpassword(void* lpObj);
int ipworksssl_soap_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (SOAP Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksssl_soap_getfirewallport(void* lpObj);
int ipworksssl_soap_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (SOAP Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksssl_soap_getfirewalluser(void* lpObj);
int ipworksssl_soap_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FollowRedirects Property (SOAP Class)

This property determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

FR_NEVER(0), 
FR_ALWAYS(1), 
FR_SAME_SCHEME(2)

int ipworksssl_soap_getfollowredirects(void* lpObj);
int ipworksssl_soap_setfollowredirects(void* lpObj, int iFollowRedirects);

int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Default Value

0

Remarks

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

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

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

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

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

Data Type

Integer

Idle Property (SOAP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksssl_soap_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIfModifiedSince();
int SetIfModifiedSince(const char* lpszIfModifiedSince);

Unicode (Windows)
LPWSTR GetIfModifiedSince();
INT SetIfModifiedSince(LPCWSTR lpszIfModifiedSince);

char* ipworksssl_soap_getifmodifiedsince(void* lpObj);
int ipworksssl_soap_setifmodifiedsince(void* lpObj, const char* lpszIfModifiedSince);

QString GetIfModifiedSince();
int SetIfModifiedSince(QString qsIfModifiedSince);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

LocalFile Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* ipworksssl_soap_getlocalfile(void* lpObj);
wchar_t* ipworksssl_soap_getlocalfile_W(void* lpObj); // Windows only
int ipworksssl_soap_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworksssl_soap_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property is used when getting a document.

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

Data Type

String

LocalHost Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksssl_soap_getlocalhost(void* lpObj);
int ipworksssl_soap_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

Data Type

String

Method Property (SOAP Class)

The remote Method .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMethod();
int SetMethod(const char* lpszMethod);

Unicode (Windows)
LPWSTR GetMethod();
INT SetMethod(LPCWSTR lpszMethod);

char* ipworksssl_soap_getmethod(void* lpObj);
int ipworksssl_soap_setmethod(void* lpObj, const char* lpszMethod);

QString GetMethod();
int SetMethod(QString qsMethod);

Default Value

""

Remarks

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

Data Type

String

MethodURI Property (SOAP Class)

The URI corresponding to the SOAP Method .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMethodURI();
int SetMethodURI(const char* lpszMethodURI);

Unicode (Windows)
LPWSTR GetMethodURI();
INT SetMethodURI(LPCWSTR lpszMethodURI);

char* ipworksssl_soap_getmethoduri(void* lpObj);
int ipworksssl_soap_setmethoduri(void* lpObj, const char* lpszMethodURI);

QString GetMethodURI();
int SetMethodURI(QString qsMethodURI);

Default Value

""

Remarks

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

Data Type

String

NamespaceCount Property (SOAP Class)

The number of records in the Namespace arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

Unicode (Windows)
INT GetNamespaceCount();
INT SetNamespaceCount(INT iNamespaceCount);

int ipworksssl_soap_getnamespacecount(void* lpObj);
int ipworksssl_soap_setnamespacecount(void* lpObj, int iNamespaceCount);

int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

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

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (SOAP Class)

The Prefix for the Namespace .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, const char* lpszNamespacePrefix);

Unicode (Windows)
LPWSTR GetNamespacePrefix(INT iNamespaceIndex);
INT SetNamespacePrefix(INT iNamespaceIndex, LPCWSTR lpszNamespacePrefix);

char* ipworksssl_soap_getnamespaceprefix(void* lpObj, int namespaceindex);
int ipworksssl_soap_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix);

Default Value

""

Remarks

The NamespacePrefix for the Namespace.

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

This property is not available at design time.

Data Type

String

NamespaceURI Property (SOAP Class)

Namespace URI associated with the corresponding Prefix .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, const char* lpszNamespaceURI);

Unicode (Windows)
LPWSTR GetNamespaceURI(INT iNamespaceIndex);
INT SetNamespaceURI(INT iNamespaceIndex, LPCWSTR lpszNamespaceURI);

char* ipworksssl_soap_getnamespaceuri(void* lpObj, int namespaceindex);
int ipworksssl_soap_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

OtherHeaders Property (SOAP Class)

This property includes other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworksssl_soap_getotherheaders(void* lpObj);
int ipworksssl_soap_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

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

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

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

This property is not available at design time.

Data Type

String

ParamCount Property (SOAP Class)

The number of records in the Param arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParamCount();
int SetParamCount(int iParamCount);

Unicode (Windows)
INT GetParamCount();
INT SetParamCount(INT iParamCount);

int ipworksssl_soap_getparamcount(void* lpObj);
int ipworksssl_soap_setparamcount(void* lpObj, int iParamCount);

int GetParamCount();
int SetParamCount(int iParamCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParamAttrs
• ParamName
• ParamValue

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

This property is not available at design time.

Data Type

Integer

ParamAttrs Property (SOAP Class)

Extra attributes for the parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParamAttrs(int iParamIndex);
int SetParamAttrs(int iParamIndex, const char* lpszParamAttrs);

Unicode (Windows)
LPWSTR GetParamAttrs(INT iParamIndex);
INT SetParamAttrs(INT iParamIndex, LPCWSTR lpszParamAttrs);

char* ipworksssl_soap_getparamattrs(void* lpObj, int paramindex);
int ipworksssl_soap_setparamattrs(void* lpObj, int paramindex, const char* lpszParamAttrs);

QString GetParamAttrs(int iParamIndex);
int SetParamAttrs(int iParamIndex, QString qsParamAttrs);

Default Value

""

Remarks

Extra attributes for the parameter.

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

This property is not available at design time.

Data Type

String

ParamName Property (SOAP Class)

The name of the Method parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, const char* lpszParamName);

Unicode (Windows)
LPWSTR GetParamName(INT iParamIndex);
INT SetParamName(INT iParamIndex, LPCWSTR lpszParamName);

char* ipworksssl_soap_getparamname(void* lpObj, int paramindex);
int ipworksssl_soap_setparamname(void* lpObj, int paramindex, const char* lpszParamName);

QString GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, QString qsParamName);

Default Value

""

Remarks

The name of the Method parameter.

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

This property is not available at design time.

Data Type

String

ParamValue Property (SOAP Class)

The value of the Method parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, const char* lpszParamValue);

Unicode (Windows)
LPWSTR GetParamValue(INT iParamIndex);
INT SetParamValue(INT iParamIndex, LPCWSTR lpszParamValue);

char* ipworksssl_soap_getparamvalue(void* lpObj, int paramindex);
int ipworksssl_soap_setparamvalue(void* lpObj, int paramindex, const char* lpszParamValue);

QString GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, QString qsParamValue);

Default Value

""

Remarks

The value of the Method parameter.

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

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (SOAP Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int ipworksssl_soap_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

char* ipworksssl_soap_getparsedheaderfield(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

ParsedHeaderValue Property (SOAP Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

char* ipworksssl_soap_getparsedheadervalue(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

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

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

Data Type

String

Password Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksssl_soap_getpassword(void* lpObj);
int ipworksssl_soap_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

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

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

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

Data Type

String

Pragma Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPragma();
int SetPragma(const char* lpszPragma);

Unicode (Windows)
LPWSTR GetPragma();
INT SetPragma(LPCWSTR lpszPragma);

char* ipworksssl_soap_getpragma(void* lpObj);
int ipworksssl_soap_setpragma(void* lpObj, const char* lpszPragma);

QString GetPragma();
int SetPragma(QString qsPragma);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (SOAP Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int ipworksssl_soap_getproxyauthscheme(void* lpObj);
int ipworksssl_soap_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (SOAP Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int ipworksssl_soap_getproxyautodetect(void* lpObj);
int ipworksssl_soap_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (SOAP Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_soap_getproxypassword(void* lpObj);
int ipworksssl_soap_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

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

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

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

Data Type

String

ProxyPort Property (SOAP Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_soap_getproxyport(void* lpObj);
int ipworksssl_soap_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* ipworksssl_soap_getproxyserver(void* lpObj);
int ipworksssl_soap_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (SOAP Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int ipworksssl_soap_getproxyssl(void* lpObj);
int ipworksssl_soap_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (SOAP Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* ipworksssl_soap_getproxyuser(void* lpObj);
int ipworksssl_soap_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

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

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

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

Data Type

String

Referer Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferer();
int SetReferer(const char* lpszReferer);

Unicode (Windows)
LPWSTR GetReferer();
INT SetReferer(LPCWSTR lpszReferer);

char* ipworksssl_soap_getreferer(void* lpObj);
int ipworksssl_soap_setreferer(void* lpObj, const char* lpszReferer);

QString GetReferer();
int SetReferer(QString qsReferer);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ReturnValue Property (SOAP Class)

Value returned by the SOAP Method .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnValue();

Unicode (Windows)
LPWSTR GetReturnValue();

char* ipworksssl_soap_getreturnvalue(void* lpObj);

QString GetReturnValue();

Default Value

""

Remarks

ReturnValue corresponds to the first item in the Params properties.

This property is read-only.

Data Type

String

SOAPEncoding Property (SOAP Class)

The type of SOAP Encoding used for SOAP requests.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSOAPEncoding();
int SetSOAPEncoding(const char* lpszSOAPEncoding);

Unicode (Windows)
LPWSTR GetSOAPEncoding();
INT SetSOAPEncoding(LPCWSTR lpszSOAPEncoding);

char* ipworksssl_soap_getsoapencoding(void* lpObj);
int ipworksssl_soap_setsoapencoding(void* lpObj, const char* lpszSOAPEncoding);

QString GetSOAPEncoding();
int SetSOAPEncoding(QString qsSOAPEncoding);

Default Value

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

Remarks

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

Data Type

String

SOAPHeader Property (SOAP Class)

Contents of the optional SOAP header sent to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSOAPHeader();
int SetSOAPHeader(const char* lpszSOAPHeader);

Unicode (Windows)
LPWSTR GetSOAPHeader();
INT SetSOAPHeader(LPCWSTR lpszSOAPHeader);

char* ipworksssl_soap_getsoapheader(void* lpObj);
int ipworksssl_soap_setsoapheader(void* lpObj, const char* lpszSOAPHeader);

QString GetSOAPHeader();
int SetSOAPHeader(QString qsSOAPHeader);

Default Value

""

Remarks

This property is used only while building SOAP requests.

This property is not available at design time.

Data Type

String

SOAPPacket Property (SOAP Class)

Full contents of the SOAP packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSOAPPacket();
int SetSOAPPacket(const char* lpszSOAPPacket);

Unicode (Windows)
LPWSTR GetSOAPPacket();
INT SetSOAPPacket(LPCWSTR lpszSOAPPacket);

char* ipworksssl_soap_getsoappacket(void* lpObj);
int ipworksssl_soap_setsoappacket(void* lpObj, const char* lpszSOAPPacket);

QString GetSOAPPacket();
int SetSOAPPacket(QString qsSOAPPacket);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (SOAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksssl_soap_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksssl_soap_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (SOAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksssl_soap_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_soap_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (SOAP Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksssl_soap_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_soap_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksssl_soap_getsslcertstorepassword(void* lpObj);
int ipworksssl_soap_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (SOAP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksssl_soap_getsslcertstoretype(void* lpObj);
int ipworksssl_soap_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (SOAP Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksssl_soap_getsslcertsubject(void* lpObj);
int ipworksssl_soap_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (SOAP Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksssl_soap_getsslprovider(void* lpObj);
int ipworksssl_soap_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

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

Possible values are:

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (SOAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworksssl_soap_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

StatusLine Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStatusLine();

Unicode (Windows)
LPWSTR GetStatusLine();

char* ipworksssl_soap_getstatusline(void* lpObj);

QString GetStatusLine();

Default Value

""

Remarks

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

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

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

Data Type

String

Timeout Property (SOAP Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksssl_soap_gettimeout(void* lpObj);
int ipworksssl_soap_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransferredData(char* &lpTransferredData, int &lenTransferredData);

Unicode (Windows)
INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);

int ipworksssl_soap_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);

QByteArray GetTransferredData();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

TransferredDataLimit Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetTransferredDataLimit();
int SetTransferredDataLimit(int64 lTransferredDataLimit);

Unicode (Windows)
LONG64 GetTransferredDataLimit();
INT SetTransferredDataLimit(LONG64 lTransferredDataLimit);

int64 ipworksssl_soap_gettransferreddatalimit(void* lpObj);
int ipworksssl_soap_settransferreddatalimit(void* lpObj, int64 lTransferredDataLimit);

qint64 GetTransferredDataLimit();
int SetTransferredDataLimit(qint64 lTransferredDataLimit);

Default Value

0

Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.

Data Type

Long64

TransferredHeaders Property (SOAP Class)

This property includes the full set of headers as received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();

char* ipworksssl_soap_gettransferredheaders(void* lpObj);

QString GetTransferredHeaders();

Default Value

""

Remarks

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

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

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

Data Type

String

URL Property (SOAP Class)

This property specifies the URL to fetch.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL);

Unicode (Windows)
LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);

char* ipworksssl_soap_geturl(void* lpObj);
int ipworksssl_soap_seturl(void* lpObj, const char* lpszURL);

QString GetURL();
int SetURL(QString qsURL);

Default Value

""

Remarks

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

Data Type

String

User Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksssl_soap_getuser(void* lpObj);
int ipworksssl_soap_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

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

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

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

Data Type

String

ValueFormat Property (SOAP Class)

Format of data returned or set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetValueFormat();
int SetValueFormat(int iValueFormat);

Unicode (Windows)
INT GetValueFormat();
INT SetValueFormat(INT iValueFormat);

VF_TEXT(0), 
VF_XML(1), 
VF_FULL_XML(2)

int ipworksssl_soap_getvalueformat(void* lpObj);
int ipworksssl_soap_setvalueformat(void* lpObj, int iValueFormat);

int GetValueFormat();
int SetValueFormat(int iValueFormat);

Default Value

1

Remarks

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

The following are the possible values:

Data Type

Integer

AttrCount Property (SOAP Class)

The number of records in the Attr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrCount();

Unicode (Windows)
INT GetAttrCount();

int ipworksssl_soap_getattrcount(void* lpObj);

int GetAttrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

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

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

Data Type

Integer

AttrName Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrName(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrName(INT iAttrIndex);

char* ipworksssl_soap_getattrname(void* lpObj, int attrindex);

QString GetAttrName(int iAttrIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

AttrNamespace Property (SOAP Class)

Attribute namespace.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrNamespace(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrNamespace(INT iAttrIndex);

char* ipworksssl_soap_getattrnamespace(void* lpObj, int attrindex);

QString GetAttrNamespace(int iAttrIndex);

Default Value

""

Remarks

Attribute namespace.

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

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

Data Type

String

AttrPrefix Property (SOAP Class)

Attribute prefix (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrPrefix(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrPrefix(INT iAttrIndex);

char* ipworksssl_soap_getattrprefix(void* lpObj, int attrindex);

QString GetAttrPrefix(int iAttrIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

AttrValue Property (SOAP Class)

Attribute value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrValue(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrValue(INT iAttrIndex);

char* ipworksssl_soap_getattrvalue(void* lpObj, int attrindex);

QString GetAttrValue(int iAttrIndex);

Default Value

""

Remarks

Attribute value.

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

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

Data Type

String

XChildCount Property (SOAP Class)

The number of records in the XChild arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetXChildCount();

Unicode (Windows)
INT GetXChildCount();

int ipworksssl_soap_getxchildcount(void* lpObj);

int GetXChildCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

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

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

Data Type

Integer

XChildName Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildName(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildName(INT iXChildIndex);

char* ipworksssl_soap_getxchildname(void* lpObj, int xchildindex);

QString GetXChildName(int iXChildIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

XChildNamespace Property (SOAP Class)

Namespace of the element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildNamespace(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildNamespace(INT iXChildIndex);

char* ipworksssl_soap_getxchildnamespace(void* lpObj, int xchildindex);

QString GetXChildNamespace(int iXChildIndex);

Default Value

""

Remarks

Namespace of the element.

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

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

Data Type

String

XChildPrefix Property (SOAP Class)

Prefix of the element (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildPrefix(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildPrefix(INT iXChildIndex);

char* ipworksssl_soap_getxchildprefix(void* lpObj, int xchildindex);

QString GetXChildPrefix(int iXChildIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

XChildXText Property (SOAP Class)

The inner text of the element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildXText(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildXText(INT iXChildIndex);

char* ipworksssl_soap_getxchildxtext(void* lpObj, int xchildindex);

QString GetXChildXText(int iXChildIndex);

Default Value

""

Remarks

The inner text of the element.

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

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

Data Type

String

XElement Property (SOAP Class)

The name of the element pointed to by XPath .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXElement();

Unicode (Windows)
LPWSTR GetXElement();

char* ipworksssl_soap_getxelement(void* lpObj);

QString GetXElement();

Default Value

""

Remarks

The corresponding prefix is provided by XPrefix.

This property is read-only.

Data Type

String

XNamespace Property (SOAP Class)

The namespace of the element pointed to by XPath .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXNamespace();

Unicode (Windows)
LPWSTR GetXNamespace();

char* ipworksssl_soap_getxnamespace(void* lpObj);

QString GetXNamespace();

Default Value

""

Remarks

The corresponding namespace prefix is provided by XPrefix.

This property is read-only.

Data Type

String

XParent Property (SOAP Class)

The parent of the element pointed to by XPath .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXParent();

Unicode (Windows)
LPWSTR GetXParent();

char* ipworksssl_soap_getxparent(void* lpObj);

QString GetXParent();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

XPath Property (SOAP Class)

A path into the SOAPPacket received by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);

char* ipworksssl_soap_getxpath(void* lpObj);
int ipworksssl_soap_setxpath(void* lpObj, const char* lpszXPath);

QString GetXPath();
int SetXPath(QString qsXPath);

Default Value

""

Remarks

The syntax is a subset of the XPath language.

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

Data Type

String

XPrefix Property (SOAP Class)

The prefix of the element pointed to by XPath .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPrefix();

Unicode (Windows)
LPWSTR GetXPrefix();

char* ipworksssl_soap_getxprefix(void* lpObj);

QString GetXPrefix();

Default Value

""

Remarks

The corresponding element name is provided by XElement.

This property is read-only.

Data Type

String

XText Property (SOAP Class)

The text of the element pointed to by XPath .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXText();

Unicode (Windows)
LPWSTR GetXText();

char* ipworksssl_soap_getxtext(void* lpObj);

QString GetXText();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

AddCookie Method (SOAP Class)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCookie(const char* lpszCookieName, const char* lpszCookieValue);

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);

int ipworksssl_soap_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);

Remarks

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

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

AddNamespace Method (SOAP Class)

Adds a namespace to the Namespaces properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddNamespace(const char* lpszPrefix, const char* lpszNamespaceURI);

Unicode (Windows)
INT AddNamespace(LPCWSTR lpszPrefix, LPCWSTR lpszNamespaceURI);

int ipworksssl_soap_addnamespace(void* lpObj, const char* lpszPrefix, const char* lpszNamespaceURI);

int AddNamespace(const QString& qsPrefix, const QString& qsNamespaceURI);

Remarks

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

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

AddParam Method (SOAP Class)

Adds a parameter-value pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddParam(const char* lpszParamName, const char* lpszParamValue);

Unicode (Windows)
INT AddParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue);

int ipworksssl_soap_addparam(void* lpObj, const char* lpszParamName, const char* lpszParamValue);

int AddParam(const QString& qsParamName, const QString& qsParamValue);

Remarks

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

Example (Send SOAP Request)

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

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

Attr Method (SOAP Class)

This method returns the value of the specified attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Attr(const char* lpszAttrName);

Unicode (Windows)
LPWSTR Attr(LPCWSTR lpszAttrName);

char* ipworksssl_soap_attr(void* lpObj, const char* lpszAttrName);

QString Attr(const QString& qsAttrName);

Remarks

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

Please refer to the XAttributes properties for more information.

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.

BuildPacket Method (SOAP Class)

Build the request packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BuildPacket();

Unicode (Windows)
INT BuildPacket();

int ipworksssl_soap_buildpacket(void* lpObj);

int BuildPacket();

Remarks

The resulting packet is placed in SOAPPacket.

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

Config Method (SOAP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

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

DoEvents Method (SOAP Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssl_soap_doevents(void* lpObj);

int DoEvents();

Remarks

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

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

EvalPacket Method (SOAP Class)

Evaluate the packet in SOAPPacket .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EvalPacket();

Unicode (Windows)
INT EvalPacket();

int ipworksssl_soap_evalpacket(void* lpObj);

int EvalPacket();

Remarks

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

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

HasXPath Method (SOAP Class)

Determines whether a specific element exists in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int HasXPath(const char* lpszXPath);

Unicode (Windows)
INT HasXPath(LPCWSTR lpszXPath);

int ipworksssl_soap_hasxpath(void* lpObj, const char* lpszXPath);

bool HasXPath(const QString& qsXPath);

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath.

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

See XPath for details on the XPath syntax.

Error Handling (C++)

This method returns a Boolean 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.

Interrupt Method (SOAP Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksssl_soap_interrupt(void* lpObj);

int Interrupt();

Remarks

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

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

Reset Method (SOAP Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssl_soap_reset(void* lpObj);

int Reset();

Remarks

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

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

SendPacket Method (SOAP Class)

Send the packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendPacket();

Unicode (Windows)
INT SendPacket();

int ipworksssl_soap_sendpacket(void* lpObj);

int SendPacket();

Remarks

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

Example (Send SOAP Request)

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

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

SendRequest Method (SOAP Class)

Send the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendRequest();

Unicode (Windows)
INT SendRequest();

int ipworksssl_soap_sendrequest(void* lpObj);

int SendRequest();

Remarks

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

Example (Send SOAP Request)

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

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

TryXPath Method (SOAP Class)

Navigates to the specified XPath if it exists.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int TryXPath(const char* lpszxpath);

Unicode (Windows)
INT TryXPath(LPCWSTR lpszxpath);

int ipworksssl_soap_tryxpath(void* lpObj, const char* lpszxpath);

bool TryXPath(const QString& qsxpath);

Remarks

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

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

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

Error Handling (C++)

This method returns a Boolean 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.

Value Method (SOAP Class)

Returns the value of a parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Value(const char* lpszParamName);

Unicode (Windows)
LPWSTR Value(LPCWSTR lpszParamName);

char* ipworksssl_soap_value(void* lpObj, const char* lpszParamName);

QString Value(const QString& qsParamName);

Remarks

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

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.

Connected Event (SOAP Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SOAPConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} SOAPConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(SOAPConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SOAPConnectedEventParams;

#define EID_SOAP_CONNECTED 1

virtual INT IPWORKSSSL_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class SOAPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(SOAPConnectedEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireConnected(SOAPConnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SOAP Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(SOAPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} SOAPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(SOAPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SOAPConnectionStatusEventParams;

#define EID_SOAP_CONNECTIONSTATUS 2

virtual INT IPWORKSSSL_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class SOAPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(SOAPConnectionStatusEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireConnectionStatus(SOAPConnectionStatusEventParams *e) {...}

Remarks

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

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

Disconnected Event (SOAP Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SOAPDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} SOAPDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(SOAPDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SOAPDisconnectedEventParams;

#define EID_SOAP_DISCONNECTED 3

virtual INT IPWORKSSSL_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class SOAPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(SOAPDisconnectedEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireDisconnected(SOAPDisconnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (SOAP Class)

Fired when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(SOAPEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} SOAPEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(SOAPEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} SOAPEndTransferEventParams;

#define EID_SOAP_ENDTRANSFER 4

virtual INT IPWORKSSSL_CALL FireEndTransfer(INT &iDirection);

class SOAPEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(SOAPEndTransferEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireEndTransfer(SOAPEndTransferEventParams *e) {...}

Remarks

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

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

Error Event (SOAP Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SOAPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SOAPErrorEventParams;


Unicode (Windows)
virtual INT FireError(SOAPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SOAPErrorEventParams;

#define EID_SOAP_ERROR 5

virtual INT IPWORKSSSL_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SOAPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SOAPErrorEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireError(SOAPErrorEventParams *e) {...}

Remarks

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

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

Header Event (SOAP Class)

This event is fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(SOAPHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} SOAPHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(SOAPHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} SOAPHeaderEventParams;

#define EID_SOAP_HEADER 6

virtual INT IPWORKSSSL_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class SOAPHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(SOAPHeaderEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireHeader(SOAPHeaderEventParams *e) {...}

Remarks

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

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

Log Event (SOAP Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(SOAPLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} SOAPLogEventParams;


Unicode (Windows)
virtual INT FireLog(SOAPLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} SOAPLogEventParams;

#define EID_SOAP_LOG 7

virtual INT IPWORKSSSL_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class SOAPLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(SOAPLogEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireLog(SOAPLogEventParams *e) {...}

Remarks

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

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

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

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

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

Redirect Event (SOAP Class)

This event is fired when a redirection is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRedirect(SOAPRedirectEventParams *e);

typedef struct {
  const char *Location;
  int Accept;
  int reserved;
} SOAPRedirectEventParams;


Unicode (Windows)
virtual INT FireRedirect(SOAPRedirectEventParams *e);

typedef struct {
  LPCWSTR Location;
  BOOL Accept;
  INT reserved;
} SOAPRedirectEventParams;

#define EID_SOAP_REDIRECT 8

virtual INT IPWORKSSSL_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);

class SOAPRedirectEventParams {
public:
  const QString &Location();

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Redirect(SOAPRedirectEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireRedirect(SOAPRedirectEventParams *e) {...}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (SOAP Class)

This event is fired for every cookie set by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetCookie(SOAPSetCookieEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  const char *Expires;
  const char *Domain;
  const char *Path;
  int Secure;
  int reserved;
} SOAPSetCookieEventParams;


Unicode (Windows)
virtual INT FireSetCookie(SOAPSetCookieEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  LPCWSTR Expires;
  LPCWSTR Domain;
  LPCWSTR Path;
  BOOL Secure;
  INT reserved;
} SOAPSetCookieEventParams;

#define EID_SOAP_SETCOOKIE 9

virtual INT IPWORKSSSL_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);

class SOAPSetCookieEventParams {
public:
  const QString &Name();

  const QString &Value();

  const QString &Expires();

  const QString &Domain();

  const QString &Path();

  bool Secure();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SetCookie(SOAPSetCookieEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireSetCookie(SOAPSetCookieEventParams *e) {...}

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (SOAP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SOAPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SOAPSSLServerAuthenticationEventParams;

#define EID_SOAP_SSLSERVERAUTHENTICATION 10

virtual INT IPWORKSSSL_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SOAPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireSSLServerAuthentication(SOAPSSLServerAuthenticationEventParams *e) {...}

Remarks

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

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

SSLStatus Event (SOAP Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(SOAPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} SOAPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(SOAPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} SOAPSSLStatusEventParams;

#define EID_SOAP_SSLSTATUS 11

virtual INT IPWORKSSSL_CALL FireSSLStatus(LPSTR &lpszMessage);

class SOAPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(SOAPSSLStatusEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireSSLStatus(SOAPSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (SOAP Class)

Fired when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(SOAPStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} SOAPStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(SOAPStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} SOAPStartTransferEventParams;

#define EID_SOAP_STARTTRANSFER 12

virtual INT IPWORKSSSL_CALL FireStartTransfer(INT &iDirection);

class SOAPStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(SOAPStartTransferEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireStartTransfer(SOAPStartTransferEventParams *e) {...}

Remarks

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

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

Status Event (SOAP Class)

This event is fired when the HTTP status line is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(SOAPStatusEventParams *e);

typedef struct {
  const char *HTTPVersion;
  int StatusCode;
  const char *Description;
  int reserved;
} SOAPStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(SOAPStatusEventParams *e);

typedef struct {
  LPCWSTR HTTPVersion;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SOAPStatusEventParams;

#define EID_SOAP_STATUS 13

virtual INT IPWORKSSSL_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);

class SOAPStatusEventParams {
public:
  const QString &HTTPVersion();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(SOAPStatusEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireStatus(SOAPStatusEventParams *e) {...}

Remarks

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

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

Transfer Event (SOAP Class)

Fired while the response transfers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(SOAPTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  int reserved;
} SOAPTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(SOAPTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  INT reserved;
} SOAPTransferEventParams;

#define EID_SOAP_TRANSFER 14

virtual INT IPWORKSSSL_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone);

class SOAPTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(SOAPTransferEventParams *e);

// Or, subclass SOAP and override this emitter function.
virtual int FireTransfer(SOAPTransferEventParams *e) {...}

Remarks

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

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

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

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

Config Settings (SOAP Class)

SOAP Config Settings

HTTP Config Settings

TCPClient Config Settings