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 Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

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

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

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

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

The 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 in which the underlying SOAP transport is not HTTP but another mechanism (e.g., SMTP and POP for email).

By providing direct access to the SOAP packet in offline mode, the 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* ipworks_soap_getaccept(void* lpObj);
int ipworks_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)

This property includes 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* ipworks_soap_getactionuri(void* lpObj);
int ipworks_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* ipworks_soap_getauthorization(void* lpObj);
int ipworks_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)

This property specifies 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 ipworks_soap_getauthscheme(void* lpObj);
int ipworks_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)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworks_soap_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ContentType Property (SOAP Class)

This property includes the 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* ipworks_soap_getcontenttype(void* lpObj);
int ipworks_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

Cookies Property (SOAP Class)

A collection of cookies.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHTTPCookie>* GetCookies();
int SetCookies(IPWorksList<IPWorksHTTPCookie>* val);

int ipworks_soap_getcookiecount(void* lpObj);
int ipworks_soap_setcookiecount(void* lpObj, int iCookieCount);

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

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

char* ipworks_soap_getcookiename(void* lpObj, int cookieindex);
int ipworks_soap_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

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

int ipworks_soap_getcookiesecure(void* lpObj, int cookieindex);

char* ipworks_soap_getcookievalue(void* lpObj, int cookieindex);
int ipworks_soap_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

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

QString GetCookieDomain(int iCookieIndex);

QString GetCookieExpiration(int iCookieIndex);

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

QString GetCookiePath(int iCookieIndex);

bool GetCookieSecure(int iCookieIndex);

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

Remarks

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

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

Data Type

IPWorksHTTPCookie

FaultActor Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFaultActor();

Unicode (Windows)
LPWSTR GetFaultActor();

char* ipworks_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)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFaultCode();

Unicode (Windows)
LPWSTR GetFaultCode();

char* ipworks_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)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFaultString();

Unicode (Windows)
LPWSTR GetFaultString();

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

Firewall Property (SOAP Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksFirewall* GetFirewall();
int SetFirewall(IPWorksFirewall* val);

int ipworks_soap_getfirewallautodetect(void* lpObj);
int ipworks_soap_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworks_soap_getfirewalltype(void* lpObj);
int ipworks_soap_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworks_soap_getfirewallhost(void* lpObj);
int ipworks_soap_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworks_soap_getfirewallpassword(void* lpObj);
int ipworks_soap_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworks_soap_getfirewallport(void* lpObj);
int ipworks_soap_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworks_soap_getfirewalluser(void* lpObj);
int ipworks_soap_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

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

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

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

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

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

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksFirewall

FollowRedirects Property (SOAP Class)

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 ipworks_soap_getfollowredirects(void* lpObj);
int ipworks_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 ipworks_soap_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (SOAP 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* ipworks_soap_getifmodifiedsince(void* lpObj);
int ipworks_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* ipworks_soap_getlocalfile(void* lpObj);
wchar_t* ipworks_soap_getlocalfile_W(void* lpObj); // Windows only
int ipworks_soap_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_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* ipworks_soap_getlocalhost(void* lpObj);
int ipworks_soap_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

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

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

If the 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 multihomed hosts (machines with more than one IP interface).

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

Data Type

String

Method Property (SOAP Class)

This property includes 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* ipworks_soap_getmethod(void* lpObj);
int ipworks_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)

This property includes 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* ipworks_soap_getmethoduri(void* lpObj);
int ipworks_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

Namespaces Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksXMLNamespace>* GetNamespaces();
int SetNamespaces(IPWorksList<IPWorksXMLNamespace>* val);

int ipworks_soap_getnamespacecount(void* lpObj);
int ipworks_soap_setnamespacecount(void* lpObj, int iNamespaceCount);

char* ipworks_soap_getnamespaceprefix(void* lpObj, int namespaceindex);
int ipworks_soap_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

char* ipworks_soap_getnamespaceuri(void* lpObj, int namespaceindex);
int ipworks_soap_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

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

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

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

Remarks

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

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

This property is not available at design time.

Data Type

IPWorksXMLNamespace

OtherHeaders Property (SOAP Class)

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* ipworks_soap_getotherheaders(void* lpObj);
int ipworks_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

Params Property (SOAP Class)

This property includes a collection of parameters for the SOAP Method .

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksSOAPParam>* GetParams();
int SetParams(IPWorksList<IPWorksSOAPParam>* val);

int ipworks_soap_getparamcount(void* lpObj);
int ipworks_soap_setparamcount(void* lpObj, int iParamCount);

char* ipworks_soap_getparamattrs(void* lpObj, int paramindex);
int ipworks_soap_setparamattrs(void* lpObj, int paramindex, const char* lpszParamAttrs);

char* ipworks_soap_getparamname(void* lpObj, int paramindex);
int ipworks_soap_setparamname(void* lpObj, int paramindex, const char* lpszParamName);

char* ipworks_soap_getparamvalue(void* lpObj, int paramindex);
int ipworks_soap_setparamvalue(void* lpObj, int paramindex, const char* lpszParamValue);

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

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

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

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

Remarks

When using SendRequest, this property can be populated with the parameters to include in the request to the SOAP Method.

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

This property is not available at design time.

Data Type

IPWorksSOAPParam

ParsedHeaders Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHeader>* GetParsedHeaders();

int ipworks_soap_getparsedheadercount(void* lpObj);

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

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

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

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

Data Type

IPWorksHeader

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* ipworks_soap_getpassword(void* lpObj);
int ipworks_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* ipworks_soap_getpragma(void* lpObj);
int ipworks_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

Proxy Property (SOAP Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorksProxy* GetProxy();
int SetProxy(IPWorksProxy* val);

int ipworks_soap_getproxyauthscheme(void* lpObj);
int ipworks_soap_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworks_soap_getproxyautodetect(void* lpObj);
int ipworks_soap_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworks_soap_getproxypassword(void* lpObj);
int ipworks_soap_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworks_soap_getproxyport(void* lpObj);
int ipworks_soap_setproxyport(void* lpObj, int iProxyPort);

char* ipworks_soap_getproxyserver(void* lpObj);
int ipworks_soap_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworks_soap_getproxyssl(void* lpObj);
int ipworks_soap_setproxyssl(void* lpObj, int iProxySSL);

char* ipworks_soap_getproxyuser(void* lpObj);
int ipworks_soap_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

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

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

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

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

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

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

Remarks

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

Data Type

IPWorksProxy

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* ipworks_soap_getreferer(void* lpObj);
int ipworks_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)

This property includes the value returned by the SOAP Method .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnValue();

Unicode (Windows)
LPWSTR GetReturnValue();

char* ipworks_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)

This property includes 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* ipworks_soap_getsoapencoding(void* lpObj);
int ipworks_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)

This property includes the 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* ipworks_soap_getsoapheader(void* lpObj);
int ipworks_soap_setsoapheader(void* lpObj, const char* lpszSOAPHeader);

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

Default Value

""

Remarks

This property is used only when building SOAP requests.

This property is not available at design time.

Data Type

String

SOAPPacket Property (SOAP Class)

This property includes the 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* ipworks_soap_getsoappacket(void* lpObj);
int ipworks_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 as well as the full, unmodified contents of the SOAP response as received from the server after the request.

This property is not available at design time.

Data Type

String

SSLAcceptServerCert Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksCertificate* val);

char* ipworks_soap_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_soap_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_soap_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_soap_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_soap_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_soap_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_soap_getsslacceptservercertissuer(void* lpObj);

char* ipworks_soap_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_soap_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_soap_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_soap_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_soap_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_soap_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_soap_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_soap_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_soap_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_soap_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_soap_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_soap_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_soap_getsslacceptservercertstoretype(void* lpObj);
int ipworks_soap_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_soap_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_soap_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_soap_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_soap_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_soap_getsslacceptservercertusage(void* lpObj);

int ipworks_soap_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_soap_getsslacceptservercertversion(void* lpObj);

char* ipworks_soap_getsslacceptservercertsubject(void* lpObj);
int ipworks_soap_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks_soap_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_soap_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

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

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

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

Data Type

IPWorksCertificate

SSLCert Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLCert();
int SetSSLCert(IPWorksCertificate* val);

char* ipworks_soap_getsslcerteffectivedate(void* lpObj);

char* ipworks_soap_getsslcertexpirationdate(void* lpObj);

char* ipworks_soap_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_soap_getsslcertfingerprint(void* lpObj);

char* ipworks_soap_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_soap_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_soap_getsslcertissuer(void* lpObj);

char* ipworks_soap_getsslcertprivatekey(void* lpObj);

int ipworks_soap_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_soap_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_soap_getsslcertpublickey(void* lpObj);

char* ipworks_soap_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_soap_getsslcertpublickeylength(void* lpObj);

char* ipworks_soap_getsslcertserialnumber(void* lpObj);

char* ipworks_soap_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_soap_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_soap_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_soap_getsslcertstorepassword(void* lpObj);
int ipworks_soap_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_soap_getsslcertstoretype(void* lpObj);
int ipworks_soap_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_soap_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_soap_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_soap_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_soap_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_soap_getsslcertusage(void* lpObj);

int ipworks_soap_getsslcertusageflags(void* lpObj);

char* ipworks_soap_getsslcertversion(void* lpObj);

char* ipworks_soap_getsslcertsubject(void* lpObj);
int ipworks_soap_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks_soap_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_soap_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

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

Data Type

IPWorksCertificate

SSLProvider Property (SOAP Class)

The Secure Sockets Layer/Transport Layer Security (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 ipworks_soap_getsslprovider(void* lpObj);
int ipworks_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 as follows:

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

SSLServerCert Property (SOAP Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_soap_getsslservercerteffectivedate(void* lpObj);

char* ipworks_soap_getsslservercertexpirationdate(void* lpObj);

char* ipworks_soap_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_soap_getsslservercertfingerprint(void* lpObj);

char* ipworks_soap_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_soap_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_soap_getsslservercertissuer(void* lpObj);

char* ipworks_soap_getsslservercertprivatekey(void* lpObj);

int ipworks_soap_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_soap_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_soap_getsslservercertpublickey(void* lpObj);

char* ipworks_soap_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_soap_getsslservercertpublickeylength(void* lpObj);

char* ipworks_soap_getsslservercertserialnumber(void* lpObj);

char* ipworks_soap_getsslservercertsignaturealgorithm(void* lpObj);

int ipworks_soap_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworks_soap_getsslservercertstorepassword(void* lpObj);

int ipworks_soap_getsslservercertstoretype(void* lpObj);

char* ipworks_soap_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_soap_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_soap_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_soap_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_soap_getsslservercertusage(void* lpObj);

int ipworks_soap_getsslservercertusageflags(void* lpObj);

char* ipworks_soap_getsslservercertversion(void* lpObj);

char* ipworks_soap_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksCertificate

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* ipworks_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)

The 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 ipworks_soap_gettimeout(void* lpObj);
int ipworks_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.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (SOAP 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 ipworks_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 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 ipworks_soap_gettransferreddatalimit(void* lpObj);
int ipworks_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)

The full set of headers as received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();

char* ipworks_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 retrieve.

Syntax

• C++
• C
• Qt

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

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

char* ipworks_soap_geturl(void* lpObj);
int ipworks_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* ipworks_soap_getuser(void* lpObj);
int ipworks_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)

This property includes the 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 ipworks_soap_getvalueformat(void* lpObj);
int ipworks_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

XAttributes Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksXMLAttribute>* GetXAttributes();

int ipworks_soap_getattrcount(void* lpObj);

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

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

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

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

int GetAttrCount();

QString GetAttrName(int iAttrIndex);

QString GetAttrNamespace(int iAttrIndex);

QString GetAttrPrefix(int iAttrIndex);

QString GetAttrValue(int iAttrIndex);

Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of XMLAttribute types.

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

Data Type

IPWorksXMLAttribute

XChildren Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksXMLElement>* GetXChildren();

int ipworks_soap_getxchildcount(void* lpObj);

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

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

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

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

int GetXChildCount();

QString GetXChildName(int iXChildIndex);

QString GetXChildNamespace(int iXChildIndex);

QString GetXChildPrefix(int iXChildIndex);

QString GetXChildXText(int iXChildIndex);

Remarks

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

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

Data Type

IPWorksXMLElement

XElement Property (SOAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXElement();

Unicode (Windows)
LPWSTR GetXElement();

char* ipworks_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)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXNamespace();

Unicode (Windows)
LPWSTR GetXNamespace();

char* ipworks_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)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXParent();

Unicode (Windows)
LPWSTR GetXParent();

char* ipworks_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)

This property includes 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* ipworks_soap_getxpath(void* lpObj);
int ipworks_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)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPrefix();

Unicode (Windows)
LPWSTR GetXPrefix();

char* ipworks_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)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXText();

Unicode (Windows)
LPWSTR GetXText();

char* ipworks_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)

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 ipworks_soap_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

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

Remarks

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

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)

This method 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 ipworks_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)

This method 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 ipworks_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 1. Send SOAP Request:

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

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* ipworks_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)

This method builds the request packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BuildPacket();

Unicode (Windows)
INT BuildPacket();

int ipworks_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* ipworks_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)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_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)

This method evaluates the packet in SOAPPacket .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EvalPacket();

Unicode (Windows)
INT EvalPacket();

int ipworks_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)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT HasXPath(LPCWSTR lpszXPath);

bool ipworks_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 through XPath.

This method returns True if the xpath exists, and 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)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_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)

This method resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_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)

This method sends the packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendPacket();

Unicode (Windows)
INT SendPacket();

int ipworks_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)

This method sends the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendRequest();

Unicode (Windows)
INT SendRequest();

int ipworks_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)

This method navigates to the specified XPath if it exists.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT TryXPath(LPCWSTR lpszxpath);

bool ipworks_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)

This method 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* ipworks_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)

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

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

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

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

Disconnected Event (SOAP Class)

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

This event is 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 IPWORKS_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)

Fired when information is available 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 IPWORKS_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)

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

Fired 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 IPWORKS_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 is fired 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)

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

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

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

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

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

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

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

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

SSLServerAuthentication Event (SOAP 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 IPWORKS_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)

Fired when secure connection progress messages are available.

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

This event is 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 IPWORKS_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)

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

This event is 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 IPWORKS_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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksCertificate (declared in ipworks.h)

Remarks

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

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksFirewall (declared in ipworks.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

Header Type

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

Syntax

IPWorksHeader (declared in ipworks.h)

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

Header()

Header(const char* lpszField, const char* lpszValue)

HTTPCookie Type

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

Syntax

IPWorksHTTPCookie (declared in ipworks.h)

Remarks

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

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

Fields

Constructors

HTTPCookie()

HTTPCookie(const char* lpszName, const char* lpszValue)

Proxy Type

The proxy the component will connect to.

Syntax

IPWorksProxy (declared in ipworks.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

SOAPParam Type

This type describes a parameter for the SOAP Method .

Syntax

IPWorksSOAPParam (declared in ipworks.h)

Remarks

This type describes a parameter of the SOAP Method. SOAPParam has fields to describe the name, value, and any attributes of the parameter being described.

Fields

Constructors

SOAPParam()

SOAPParam(const char* lpszName, const char* lpszValue)

XMLAttribute Type

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

Syntax

IPWorksXMLAttribute (declared in ipworks.h)

Remarks

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

Fields

Constructors

XMLAttribute()

XMLElement Type

This type describes an element contained within the XML document.

Syntax

IPWorksXMLElement (declared in ipworks.h)

Remarks

This type describes an XML element. The fields for this type describe the element Name, Prefix, and Namespace of the given element.

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

Fields

Constructors

XMLElement()

XMLNamespace Type

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

Syntax

IPWorksXMLNamespace (declared in ipworks.h)

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.

Fields

Constructors

XMLNamespace()

XMLNamespace(const char* lpszURI, const char* lpszPrefix)

IPWorksList Type

Syntax

IPWorksList<T> (declared in ipworks.h)

Remarks

IPWorksList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SOAP class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (SOAP Class)

SOAP Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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