ShipRequest Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to create, send, and parse a custom request.

Syntax

ShipRequest

Remarks

The ShipRequest class allows you to easily create a custom request for any operation. This is useful if you wish to support a service not currently implement by the existing classs. Requests created by this class can be used with FedEx, USPS, USPS using Endicia, and UPS.

To use this class first form the body of the request. The request body must then be passed to the component. This is done in one of two ways. For USPS with Endicia, FedEx, and UPS set PostData to the body of the request. For USPS use AddParameter.

After specifying the request data to send to the server, call SubmitTo and pass the URL of the server. This will send the request to the server and the response will be returned.

Once the call to SubmitTo returns, the XPath property may be set to a valid path within the XML returned, and XText will hold the value of the element at the given path. A full list of XPath related properties that will help you parse the response is found below:

• XAttributes
• XChildren
• XElement
• XErrorPath
• XNamespace
• XParent
• XPath
• XPrefix
• XSubTree
• XText

Following are examples of using the class to create a request for different services. Note that these examples show how to implement functionality existing in other classs. To use any of the functionality demonstrated here, you may use the corresponding class instead.

FedEx Component.PostData = @"<?xml version="1.0" encoding="UTF-8" ?>" + @"<ProcessShipmentRequest xmlns="http://fedex.com/ws/ship/v9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">" + "<WebAuthenticationDetail>" + "<UserCredential>" + "<Key>MyKey</Key>" + "<Password>MyPassword</Password>" + "</UserCredential>" + "</WebAuthenticationDetail>" + "<ClientDetail>" + "<AccountNumber>000000000</AccountNumber>" + "<Localization>" + "<LanguageCode>en</LanguageCode>" + "<LocaleCode>en</LocaleCode>" + "</Localization>" + "</ClientDetail>" + ... Component.SubmitTo("https://gatewaybeta.fedex.com:443/xml"); Component.XPath = "/ProcessShipmentReply/Notifications/Severity"; if(Component.XText == "SUCCESS") //The request was successful

USPS With Endicia Component.PostData = "postageRateRequestXML=<PostageRateRequest>" + "<RequesterID>test</RequesterID>" + "<CertifiedIntermediary>" + "<AccountID>123456</AccountID>" + "<PassPhrase>test</PassPhrase>" + "</CertifiedIntermediary>" + "<MailClass>ExpressMailInternational</MailClass>" + "<WeightOz>1</WeightOz>" + "<MailpieceShape>FlatRateEnvelope</MailpieceShape>" + "<AutomationRate>FALSE</AutomationRate>" + "<Machinable>TRUE</Machinable>" + "<Services>" + "<InsuredMail>OFF</InsuredMail>" + "</Services>" + "<FromPostalCode>10022</FromPostalCode>" + "<ToCountry>Algeria</ToCountry>" + "</PostageRateRequest>"; Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://www.envmgr.com/LabelService/EwsLabelService.asmx/CalculatePostageRateXML"); Component.XPath = "/PostageRateResponse/Status"; if(Component.XText == "0") //The request was successful

USPS Component.AddParameter("XML",@"<CarrierPickupCancelRequest USERID="User" PASSWORD="Pass"><FirmName>ABC Corp.</FirmName>" + "<SuiteOrApt>Suite 777</SuiteOrApt>" + "<Address2>1390 Market Street</Address2>" + "<Urbanization></Urbanization>" + "<City>Houston</City>" + "<State>TX</State>" + "<ZIP5>77058</ZIP5>" + "<ZIP4>1234</ZIP4>" + "<ConfirmationNumber>WTC123456789</ConfirmationNumber>" + "</CarrierPickupCancelRequest>"); Component.AddParameter("API", "CarrierPickupCancel"); Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://secure.shippingapis.com/ShippingAPITest.dll"); Component.XPath = "/CarrierPickupCancelResponse/Status"; Console.WriteLine(Component.XText);

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.

BuildDOM Property (ShipRequest Class)

When True, an internal object model of the XML document is created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBuildDOM();
int SetBuildDOM(int bBuildDOM);

Unicode (Windows)
BOOL GetBuildDOM();
INT SetBuildDOM(BOOL bBuildDOM);

int dshippingsdk_shiprequest_getbuilddom(void* lpObj);
int dshippingsdk_shiprequest_setbuilddom(void* lpObj, int bBuildDOM);

bool GetBuildDOM();
int SetBuildDOM(bool bBuildDOM);

Default Value

TRUE

Remarks

Set BuildDOM to True when you need to browse the current document through XPath.

Validate is automatically set to True when BuildDOM is set to True.

Data Type

Boolean

Connected Property (ShipRequest Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getconnected(void* lpObj);
int dshippingsdk_shiprequest_setconnected(void* lpObj, int bConnected);

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

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

ContentType Property (ShipRequest Class)

This property includes the content type for posts and puts.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getcontenttype(void* lpObj);
int dshippingsdk_shiprequest_setcontenttype(void* lpObj, const char* lpszContentType);

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

Default Value

""

Remarks

If this property contains a nonempty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a Post or Put to the server.

The most common example is posting of HTML form input data. In that case, this property must be set to "application/x-www-form-urlencoded".

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getfirewallautodetect(void* lpObj);
int dshippingsdk_shiprequest_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (ShipRequest Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_shiprequest_getfirewalltype(void* lpObj);
int dshippingsdk_shiprequest_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getfirewallhost(void* lpObj);
int dshippingsdk_shiprequest_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getfirewallpassword(void* lpObj);
int dshippingsdk_shiprequest_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getfirewallport(void* lpObj);
int dshippingsdk_shiprequest_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getfirewalluser(void* lpObj);
int dshippingsdk_shiprequest_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

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

Data Type

String

FollowRedirects Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_shiprequest_getfollowredirects(void* lpObj);
int dshippingsdk_shiprequest_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

HTTPMethod Property (ShipRequest Class)

This property includes the HTTP method used for the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHTTPMethod();
int SetHTTPMethod(const char* lpszHTTPMethod);

Unicode (Windows)
LPWSTR GetHTTPMethod();
INT SetHTTPMethod(LPCWSTR lpszHTTPMethod);

char* dshippingsdk_shiprequest_gethttpmethod(void* lpObj);
int dshippingsdk_shiprequest_sethttpmethod(void* lpObj, const char* lpszHTTPMethod);

QString GetHTTPMethod();
int SetHTTPMethod(QString qsHTTPMethod);

Default Value

""

Remarks

This property contains the HTTP method used for the request. If an empty string is provided, the HTTPMethod is determined automatically by the method being called. You may change it to a custom value if you require an HTTP method other than what is provided by the class. When providing a custom value, make the request by calling the Post method.

This property is not available at design time.

Data Type

String

Idle Property (ShipRequest Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int dshippingsdk_shiprequest_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LocalFile Property (ShipRequest 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* dshippingsdk_shiprequest_getlocalfile(void* lpObj);
wchar_t* dshippingsdk_shiprequest_getlocalfile_W(void* lpObj); // Windows only
int dshippingsdk_shiprequest_setlocalfile(void* lpObj, const char* lpszLocalFile);
int dshippingsdk_shiprequest_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 (ShipRequest 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* dshippingsdk_shiprequest_getlocalhost(void* lpObj);
int dshippingsdk_shiprequest_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

NamespaceCount Property (ShipRequest Class)

The number of records in the Namespace arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNamespaceCount();

Unicode (Windows)
INT GetNamespaceCount();

int dshippingsdk_shiprequest_getnamespacecount(void* lpObj);

int GetNamespaceCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

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

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

Data Type

Integer

NamespacePrefix Property (ShipRequest Class)

The Prefix for the Namespace .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespacePrefix(int iNamespaceIndex);

Unicode (Windows)
LPWSTR GetNamespacePrefix(INT iNamespaceIndex);

char* dshippingsdk_shiprequest_getnamespaceprefix(void* lpObj, int namespaceindex);

QString GetNamespacePrefix(int iNamespaceIndex);

Default Value

""

Remarks

The NamespacePrefix for the Namespace.

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

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

Data Type

String

NamespaceURI Property (ShipRequest Class)

Namespace URI associated with the corresponding Prefix .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespaceURI(int iNamespaceIndex);

Unicode (Windows)
LPWSTR GetNamespaceURI(INT iNamespaceIndex);

char* dshippingsdk_shiprequest_getnamespaceuri(void* lpObj, int namespaceindex);

QString GetNamespaceURI(int iNamespaceIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

OtherHeaders Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

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

ParameterCount Property (ShipRequest Class)

The number of records in the Parameter arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParameterCount();
int SetParameterCount(int iParameterCount);

Unicode (Windows)
INT GetParameterCount();
INT SetParameterCount(INT iParameterCount);

int dshippingsdk_shiprequest_getparametercount(void* lpObj);
int dshippingsdk_shiprequest_setparametercount(void* lpObj, int iParameterCount);

int GetParameterCount();
int SetParameterCount(int iParameterCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParameterName
• ParameterValue

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

This property is not available at design time.

Data Type

Integer

ParameterName Property (ShipRequest Class)

The Name of the Ship Parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParameterName(int iParamIndex);

Unicode (Windows)
LPWSTR GetParameterName(INT iParamIndex);

char* dshippingsdk_shiprequest_getparametername(void* lpObj, int paramindex);

QString GetParameterName(int iParamIndex);

Default Value

""

Remarks

The Name of the Ship Parameter.

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

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

Data Type

String

ParameterValue Property (ShipRequest Class)

The Value of the Ship Parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParameterValue(int iParamIndex);

Unicode (Windows)
LPWSTR GetParameterValue(INT iParamIndex);

char* dshippingsdk_shiprequest_getparametervalue(void* lpObj, int paramindex);

QString GetParameterValue(int iParamIndex);

Default Value

""

Remarks

The Value of the Ship Parameter.

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

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

Data Type

String

ParsedHeaderCount Property (ShipRequest Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int dshippingsdk_shiprequest_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

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

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

ParsedHeaderValue Property (ShipRequest Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

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

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

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

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

Data Type

String

PostData Property (ShipRequest Class)

This property includes the data to post with the URL if the POST method is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPostData(char* &lpPostData, int &lenPostData);
int SetPostData(const char* lpPostData, int lenPostData);

Unicode (Windows)
INT GetPostData(LPSTR &lpPostData, INT &lenPostData);
INT SetPostData(LPCSTR lpPostData, INT lenPostData);

int dshippingsdk_shiprequest_getpostdata(void* lpObj, char** lpPostData, int* lenPostData);
int dshippingsdk_shiprequest_setpostdata(void* lpObj, const char* lpPostData, int lenPostData);

QByteArray GetPostData();
int SetPostData(QByteArray qbaPostData);

Default Value

""

Remarks

This property contains the data to post with the URL if the POST method is used. If this property contains a nonempty string, then if the HTTP POST method is used (Post method), the contents of this property are appended to the HTTP request after the HTTP headers.

An HTTP Content-Length header is also added to the request. Its value is the length of the string in PostData.

The most common example is posting of HTML form input data. In that case, the ContentType property must be set to application/x-www-form-urlencoded.

Example. Performing a Post:

HTTPControl.ContentType = "application/x-www-form-urlencoded" HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US" HTTPControl.Post(myurl)

This property is not available at design time.

Data Type

Binary String

ProxyAuthScheme Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_shiprequest_getproxyauthscheme(void* lpObj);
int dshippingsdk_shiprequest_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

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

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getproxyautodetect(void* lpObj);
int dshippingsdk_shiprequest_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getproxypassword(void* lpObj);
int dshippingsdk_shiprequest_setproxypassword(void* lpObj, const char* lpszProxyPassword);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getproxyport(void* lpObj);
int dshippingsdk_shiprequest_setproxyport(void* lpObj, int iProxyPort);

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

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getproxyserver(void* lpObj);
int dshippingsdk_shiprequest_setproxyserver(void* lpObj, const char* lpszProxyServer);

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

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_shiprequest_getproxyssl(void* lpObj);
int dshippingsdk_shiprequest_setproxyssl(void* lpObj, int iProxySSL);

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

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getproxyuser(void* lpObj);
int dshippingsdk_shiprequest_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (ShipRequest Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dshippingsdk_shiprequest_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (ShipRequest Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dshippingsdk_shiprequest_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dshippingsdk_shiprequest_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getsslcertstorepassword(void* lpObj);
int dshippingsdk_shiprequest_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (ShipRequest Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_shiprequest_getsslcertstoretype(void* lpObj);
int dshippingsdk_shiprequest_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getsslcertsubject(void* lpObj);
int dshippingsdk_shiprequest_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (ShipRequest Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_shiprequest_getsslprovider(void* lpObj);
int dshippingsdk_shiprequest_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (ShipRequest Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

StatusLine Property (ShipRequest 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* dshippingsdk_shiprequest_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 (ShipRequest Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_shiprequest_gettimeout(void* lpObj);
int dshippingsdk_shiprequest_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (ShipRequest Class)

This property includes the content 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 dshippingsdk_shiprequest_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);

QByteArray GetTransferredData();

Default Value

""

Remarks

This property contains the content of the last response from the server. If the LocalFile is empty, 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 this property (by default, there is no limit).

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

Data Type

Binary String

TransferredDataLimit Property (ShipRequest Class)

This property includes the maximum number of bytes 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 dshippingsdk_shiprequest_gettransferreddatalimit(void* lpObj);
int dshippingsdk_shiprequest_settransferreddatalimit(void* lpObj, int64 lTransferredDataLimit);

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

Default Value

0

Remarks

This property defines the maximum number of bytes of data to be transferred. The default value is zero, which means there is no limit to the amount of data the class will accumulate and parse. If this value is set to a number n that is greater than zero, the class will receive only the first n bytes of data from the server.

Data Type

Long64

TransferredHeaders Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();

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

Validate Property (ShipRequest Class)

This property controls whether documents are validated during parsing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetValidate();
int SetValidate(int bValidate);

Unicode (Windows)
BOOL GetValidate();
INT SetValidate(BOOL bValidate);

int dshippingsdk_shiprequest_getvalidate(void* lpObj);
int dshippingsdk_shiprequest_setvalidate(void* lpObj, int bValidate);

bool GetValidate();
int SetValidate(bool bValidate);

Default Value

TRUE

Remarks

When true (default) the document will be validated during parsing. To disable validation set Validate to false. Disabling validation may be useful in cases where data can still be parsed even if the document is not well-formed.

Data Type

Boolean

AttrCount Property (ShipRequest Class)

The number of records in the Attr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrCount();
int SetAttrCount(int iAttrCount);

Unicode (Windows)
INT GetAttrCount();
INT SetAttrCount(INT iAttrCount);

int dshippingsdk_shiprequest_getattrcount(void* lpObj);
int dshippingsdk_shiprequest_setattrcount(void* lpObj, int iAttrCount);

int GetAttrCount();
int SetAttrCount(int iAttrCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

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

This property is not available at design time.

Data Type

Integer

AttrName Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetAttrName(INT iAttrIndex);

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

QString GetAttrName(int iAttrIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

AttrNamespace Property (ShipRequest Class)

Attribute namespace.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetAttrNamespace(INT iAttrIndex);

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

QString GetAttrNamespace(int iAttrIndex);

Default Value

""

Remarks

Attribute namespace.

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

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

Data Type

String

AttrPrefix Property (ShipRequest Class)

Attribute prefix (if any).

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetAttrPrefix(INT iAttrIndex);

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

QString GetAttrPrefix(int iAttrIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

AttrValue Property (ShipRequest Class)

Attribute value.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetAttrValue(INT iAttrIndex);

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

QString GetAttrValue(int iAttrIndex);

Default Value

""

Remarks

Attribute value.

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

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

Data Type

String

XChildCount Property (ShipRequest Class)

The number of records in the XChild arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetXChildCount();
int SetXChildCount(int iXChildCount);

Unicode (Windows)
INT GetXChildCount();
INT SetXChildCount(INT iXChildCount);

int dshippingsdk_shiprequest_getxchildcount(void* lpObj);
int dshippingsdk_shiprequest_setxchildcount(void* lpObj, int iXChildCount);

int GetXChildCount();
int SetXChildCount(int iXChildCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

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

This property is not available at design time.

Data Type

Integer

XChildName Property (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetXChildName(INT iXChildIndex);

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

QString GetXChildName(int iXChildIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

XChildNamespace Property (ShipRequest Class)

Namespace of the element.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetXChildNamespace(INT iXChildIndex);

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

QString GetXChildNamespace(int iXChildIndex);

Default Value

""

Remarks

Namespace of the element.

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

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

Data Type

String

XChildPrefix Property (ShipRequest Class)

Prefix of the element (if any).

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetXChildPrefix(INT iXChildIndex);

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

QString GetXChildPrefix(int iXChildIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

XChildXText Property (ShipRequest Class)

The inner text of the element.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetXChildXText(INT iXChildIndex);

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

QString GetXChildXText(int iXChildIndex);

Default Value

""

Remarks

The inner text of the element.

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

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

Data Type

String

XElement Property (ShipRequest Class)

The name of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXElement();
int SetXElement(const char* lpszXElement);

Unicode (Windows)
LPWSTR GetXElement();
INT SetXElement(LPCWSTR lpszXElement);

char* dshippingsdk_shiprequest_getxelement(void* lpObj);
int dshippingsdk_shiprequest_setxelement(void* lpObj, const char* lpszXElement);

QString GetXElement();
int SetXElement(QString qsXElement);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XErrorPath Property (ShipRequest Class)

This property includes the XPath to check the server response for errors.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXErrorPath();
int SetXErrorPath(const char* lpszXErrorPath);

Unicode (Windows)
LPWSTR GetXErrorPath();
INT SetXErrorPath(LPCWSTR lpszXErrorPath);

char* dshippingsdk_shiprequest_getxerrorpath(void* lpObj);
int dshippingsdk_shiprequest_setxerrorpath(void* lpObj, const char* lpszXErrorPath);

QString GetXErrorPath();
int SetXErrorPath(QString qsXErrorPath);

Default Value

""

Remarks

This property contains an XPath to check the server response for errors. If the XPath exists, an exception will be thrown containing the value of the element at the path.

Data Type

String

XNamespace Property (ShipRequest Class)

The namespace of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXNamespace();
int SetXNamespace(const char* lpszXNamespace);

Unicode (Windows)
LPWSTR GetXNamespace();
INT SetXNamespace(LPCWSTR lpszXNamespace);

char* dshippingsdk_shiprequest_getxnamespace(void* lpObj);
int dshippingsdk_shiprequest_setxnamespace(void* lpObj, const char* lpszXNamespace);

QString GetXNamespace();
int SetXNamespace(QString qsXNamespace);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XParent Property (ShipRequest Class)

The parent of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXParent();

Unicode (Windows)
LPWSTR GetXParent();

char* dshippingsdk_shiprequest_getxparent(void* lpObj);

QString GetXParent();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (ShipRequest Class)

Provides a way to point to a specific element in the response.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_shiprequest_getxpath(void* lpObj);
int dshippingsdk_shiprequest_setxpath(void* lpObj, const char* lpszXPath);

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

Default Value

""

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath)

Data Type

String

XPrefix Property (ShipRequest Class)

The prefix of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPrefix();
int SetXPrefix(const char* lpszXPrefix);

Unicode (Windows)
LPWSTR GetXPrefix();
INT SetXPrefix(LPCWSTR lpszXPrefix);

char* dshippingsdk_shiprequest_getxprefix(void* lpObj);
int dshippingsdk_shiprequest_setxprefix(void* lpObj, const char* lpszXPrefix);

QString GetXPrefix();
int SetXPrefix(QString qsXPrefix);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XSubTree Property (ShipRequest Class)

A snapshot of the current element in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXSubTree();

Unicode (Windows)
LPWSTR GetXSubTree();

char* dshippingsdk_shiprequest_getxsubtree(void* lpObj);

QString GetXSubTree();

Default Value

""

Remarks

The current element is specified via the XPath property. In order for this property to work you must have the CacheContent set to true.

This property is read-only.

Data Type

String

XText Property (ShipRequest Class)

The text of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXText();
int SetXText(const char* lpszXText);

Unicode (Windows)
LPWSTR GetXText();
INT SetXText(LPCWSTR lpszXText);

char* dshippingsdk_shiprequest_getxtext(void* lpObj);
int dshippingsdk_shiprequest_setxtext(void* lpObj, const char* lpszXText);

QString GetXText();
int SetXText(QString qsXText);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

AddParameter Method (ShipRequest Class)

Adds a parameter to the query string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddParameter(const char* lpszparamName, const char* lpszparamValue);

Unicode (Windows)
INT AddParameter(LPCWSTR lpszparamName, LPCWSTR lpszparamValue);

int dshippingsdk_shiprequest_addparameter(void* lpObj, const char* lpszparamName, const char* lpszparamValue);

int AddParameter(const QString& qsparamName, const QString& qsparamValue);

Remarks

This method is used to add a parameter name and value to the query string to be sent to the server. Note that any parameters added with this method will be URL encoded automatically.

If ContentType is set to "application/x-www-form-urlencoded", any parameters added with this method will be sent to the server as form data in the body of the request, instead of as query string parameters.

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

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* dshippingsdk_shiprequest_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.

Base64Decode Method (ShipRequest Class)

Decode base64 encoded string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Base64Decode(const char* lpszencodedData, int *lpSize = NULL);

Unicode (Windows)
LPSTR Base64Decode(LPCWSTR lpszencodedData, LPINT lpSize = NULL);

char* dshippingsdk_shiprequest_base64decode(void* lpObj, const char* lpszencodedData, int *lpSize);

QByteArray Base64Decode(const QString& qsencodedData);

Remarks

This method decodes the provided base64 encoded string. Some operations may result in base64 encoded data (such as a label image) being returned by the server. Use this method to decode such data. The decoded data is returned as a byte array.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); 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.

Config Method (ShipRequest 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* dshippingsdk_shiprequest_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 (ShipRequest Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

Get Method (ShipRequest Class)

This method fetches the document using the HTTP GET method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Get(const char* lpszURL);

Unicode (Windows)
INT Get(LPCWSTR lpszURL);

int dshippingsdk_shiprequest_get(void* lpObj, const char* lpszURL);

int Get(const QString& qsURL);

Remarks

This method fetches the document using the HTTP GET method. The document contents are delivered to the component and parsed. The XPath, XElement, and XText or the TransferredData property then can be used to traverse the data. The HTTP response headers are returned through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well.

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

Interrupt Method (ShipRequest Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dshippingsdk_shiprequest_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 (ShipRequest Class)

This method resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dshippingsdk_shiprequest_reset(void* lpObj);

int Reset();

Remarks

This method resets all HTTP headers to default values and resets the XML parser.

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

SubmitTo Method (ShipRequest Class)

Post current parameters to the URL specified by the 'URL' parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SubmitTo(const char* lpszURL);

Unicode (Windows)
INT SubmitTo(LPCWSTR lpszURL);

int dshippingsdk_shiprequest_submitto(void* lpObj, const char* lpszURL);

int SubmitTo(const QString& qsURL);

Remarks

A post request is sent to the URL with the specified parameters and values. The response is given via the TransferredData property.

Following are examples of using the class to create a request for different services. Note that these examples show how to implement functionality existing in other classs. To use any of the functionality demonstrated here, you may use the corresponding class instead.

FedEx Component.PostData = @"<?xml version="1.0" encoding="UTF-8" ?>" + @"<ProcessShipmentRequest xmlns="http://fedex.com/ws/ship/v9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">" + "<WebAuthenticationDetail>" + "<UserCredential>" + "<Key>MyKey</Key>" + "<Password>MyPassword</Password>" + "</UserCredential>" + "</WebAuthenticationDetail>" + "<ClientDetail>" + "<AccountNumber>000000000</AccountNumber>" + "<Localization>" + "<LanguageCode>en</LanguageCode>" + "<LocaleCode>en</LocaleCode>" + "</Localization>" + "</ClientDetail>" + ... Component.SubmitTo("https://gatewaybeta.fedex.com:443/xml"); Component.XPath = "/ProcessShipmentReply/Notifications/Severity"; if(Component.XText == "SUCCESS") //The request was successful

USPS With Endicia Component.PostData = "postageRateRequestXML=<PostageRateRequest>" + "<RequesterID>test</RequesterID>" + "<CertifiedIntermediary>" + "<AccountID>123456</AccountID>" + "<PassPhrase>test</PassPhrase>" + "</CertifiedIntermediary>" + "<MailClass>ExpressMailInternational</MailClass>" + "<WeightOz>1</WeightOz>" + "<MailpieceShape>FlatRateEnvelope</MailpieceShape>" + "<AutomationRate>FALSE</AutomationRate>" + "<Machinable>TRUE</Machinable>" + "<Services>" + "<InsuredMail>OFF</InsuredMail>" + "</Services>" + "<FromPostalCode>10022</FromPostalCode>" + "<ToCountry>Algeria</ToCountry>" + "</PostageRateRequest>"; Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://www.envmgr.com/LabelService/EwsLabelService.asmx/CalculatePostageRateXML"); Component.XPath = "/PostageRateResponse/Status"; if(Component.XText == "0") //The request was successful

USPS Component.AddParameter("XML",@"<CarrierPickupCancelRequest USERID="User" PASSWORD="Pass"><FirmName>ABC Corp.</FirmName>" + "<SuiteOrApt>Suite 777</SuiteOrApt>" + "<Address2>1390 Market Street</Address2>" + "<Urbanization></Urbanization>" + "<City>Houston</City>" + "<State>TX</State>" + "<ZIP5>77058</ZIP5>" + "<ZIP4>1234</ZIP4>" + "<ConfirmationNumber>WTC123456789</ConfirmationNumber>" + "</CarrierPickupCancelRequest>"); Component.AddParameter("API", "CarrierPickupCancel"); Component.ContentType = "application/x-www-form-urlencoded"; Component.SubmitTo("https://secure.shippingapis.com/ShippingAPITest.dll"); Component.XPath = "/CarrierPickupCancelResponse/Status"; Console.WriteLine(Component.XText);

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

Characters Event (ShipRequest Class)

Fired for plain text segments of the input stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCharacters(ShipRequestCharactersEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} ShipRequestCharactersEventParams;


Unicode (Windows)
virtual INT FireCharacters(ShipRequestCharactersEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} ShipRequestCharactersEventParams;

#define EID_SHIPREQUEST_CHARACTERS 1

virtual INT DSHIPPINGSDK_CALL FireCharacters(LPSTR &lpszText);

class ShipRequestCharactersEventParams {
public:
  const QString &Text();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireCharacters(ShipRequestCharactersEventParams *e) {...}

Remarks

The Characters event provides the plain text content of the XML document (i.e. the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end of line characters, except for ignorable whitespace which is fired through the IgnorableWhitespace event.

Comment Event (ShipRequest Class)

Fired when a comment section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireComment(ShipRequestCommentEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} ShipRequestCommentEventParams;


Unicode (Windows)
virtual INT FireComment(ShipRequestCommentEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} ShipRequestCommentEventParams;

#define EID_SHIPREQUEST_COMMENT 2

virtual INT DSHIPPINGSDK_CALL FireComment(LPSTR &lpszText);

class ShipRequestCommentEventParams {
public:
  const QString &Text();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireComment(ShipRequestCommentEventParams *e) {...}

Remarks

The Comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

Connected Event (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_CONNECTED 3

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

class ShipRequestConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireConnected(ShipRequestConnectedEventParams *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 (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_CONNECTIONSTATUS 4

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

class ShipRequestConnectionStatusEventParams {
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(ShipRequestConnectionStatusEventParams *e);

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

Remarks

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

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

Disconnected Event (ShipRequest Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_DISCONNECTED 5

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

class ShipRequestDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireDisconnected(ShipRequestDisconnectedEventParams *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.

EndElement Event (ShipRequest Class)

Fired when an end-element tag is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndElement(ShipRequestEndElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} ShipRequestEndElementEventParams;


Unicode (Windows)
virtual INT FireEndElement(ShipRequestEndElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} ShipRequestEndElementEventParams;

#define EID_SHIPREQUEST_ENDELEMENT 6

virtual INT DSHIPPINGSDK_CALL FireEndElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class ShipRequestEndElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireEndElement(ShipRequestEndElementEventParams *e) {...}

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

EndPrefixMapping Event (ShipRequest Class)

Fired when leaving the scope of a namespace declaration.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndPrefixMapping(ShipRequestEndPrefixMappingEventParams *e);

typedef struct {
  const char *Prefix;
  int reserved;
} ShipRequestEndPrefixMappingEventParams;


Unicode (Windows)
virtual INT FireEndPrefixMapping(ShipRequestEndPrefixMappingEventParams *e);

typedef struct {
  LPCWSTR Prefix;
  INT reserved;
} ShipRequestEndPrefixMappingEventParams;

#define EID_SHIPREQUEST_ENDPREFIXMAPPING 7

virtual INT DSHIPPINGSDK_CALL FireEndPrefixMapping(LPSTR &lpszPrefix);

class ShipRequestEndPrefixMappingEventParams {
public:
  const QString &Prefix();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireEndPrefixMapping(ShipRequestEndPrefixMappingEventParams *e) {...}

Remarks

The StartPrefixMapping event is fired when entering the scope of a namespace declaration.

Error Event (ShipRequest Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_ERROR 8

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

class ShipRequestErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireError(ShipRequestErrorEventParams *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.

EvalEntity Event (ShipRequest Class)

Fired every time an entity needs to be evaluated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEvalEntity(ShipRequestEvalEntityEventParams *e);

typedef struct {
  const char *Entity;
  char *Value;
  int reserved;
} ShipRequestEvalEntityEventParams;


Unicode (Windows)
virtual INT FireEvalEntity(ShipRequestEvalEntityEventParams *e);

typedef struct {
  LPCWSTR Entity;
  LPWSTR Value;
  INT reserved;
} ShipRequestEvalEntityEventParams;

#define EID_SHIPREQUEST_EVALENTITY 9

virtual INT DSHIPPINGSDK_CALL FireEvalEntity(LPSTR &lpszEntity, LPSTR &lpszValue);

class ShipRequestEvalEntityEventParams {
public:
  const QString &Entity();

  const QString &Value();
  void SetValue(const QString &qsValue);

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireEvalEntity(ShipRequestEvalEntityEventParams *e) {...}

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

Header Event (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_HEADER 10

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

class ShipRequestHeaderEventParams {
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(ShipRequestHeaderEventParams *e);

// Or, subclass ShipRequest and override this emitter function.
virtual int FireHeader(ShipRequestHeaderEventParams *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).

IgnorableWhitespace Event (ShipRequest Class)

Fired when a section of ignorable whitespace is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireIgnorableWhitespace(ShipRequestIgnorableWhitespaceEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} ShipRequestIgnorableWhitespaceEventParams;


Unicode (Windows)
virtual INT FireIgnorableWhitespace(ShipRequestIgnorableWhitespaceEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} ShipRequestIgnorableWhitespaceEventParams;

#define EID_SHIPREQUEST_IGNORABLEWHITESPACE 11

virtual INT DSHIPPINGSDK_CALL FireIgnorableWhitespace(LPSTR &lpszText);

class ShipRequestIgnorableWhitespaceEventParams {
public:
  const QString &Text();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireIgnorableWhitespace(ShipRequestIgnorableWhitespaceEventParams *e) {...}

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (ShipRequest Class)

Fired when a meta section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMeta(ShipRequestMetaEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} ShipRequestMetaEventParams;


Unicode (Windows)
virtual INT FireMeta(ShipRequestMetaEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} ShipRequestMetaEventParams;

#define EID_SHIPREQUEST_META 12

virtual INT DSHIPPINGSDK_CALL FireMeta(LPSTR &lpszText);

class ShipRequestMetaEventParams {
public:
  const QString &Text();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireMeta(ShipRequestMetaEventParams *e) {...}

Remarks

The Meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

PI Event (ShipRequest Class)

Fired when a processing instruction section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePI(ShipRequestPIEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} ShipRequestPIEventParams;


Unicode (Windows)
virtual INT FirePI(ShipRequestPIEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} ShipRequestPIEventParams;

#define EID_SHIPREQUEST_PI 13

virtual INT DSHIPPINGSDK_CALL FirePI(LPSTR &lpszText);

class ShipRequestPIEventParams {
public:
  const QString &Text();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FirePI(ShipRequestPIEventParams *e) {...}

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

Redirect Event (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_REDIRECT 14

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

class ShipRequestRedirectEventParams {
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(ShipRequestRedirectEventParams *e);

// Or, subclass ShipRequest and override this emitter function.
virtual int FireRedirect(ShipRequestRedirectEventParams *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 (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_SETCOOKIE 15

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

class ShipRequestSetCookieEventParams {
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(ShipRequestSetCookieEventParams *e);

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

Remarks

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

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

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

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

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

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

SpecialSection Event (ShipRequest Class)

Fired when a special section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSpecialSection(ShipRequestSpecialSectionEventParams *e);

typedef struct {
  const char *SectionId;
  const char *Text;
  int reserved;
} ShipRequestSpecialSectionEventParams;


Unicode (Windows)
virtual INT FireSpecialSection(ShipRequestSpecialSectionEventParams *e);

typedef struct {
  LPCWSTR SectionId;
  LPCWSTR Text;
  INT reserved;
} ShipRequestSpecialSectionEventParams;

#define EID_SHIPREQUEST_SPECIALSECTION 16

virtual INT DSHIPPINGSDK_CALL FireSpecialSection(LPSTR &lpszSectionId, LPSTR &lpszText);

class ShipRequestSpecialSectionEventParams {
public:
  const QString &SectionId();

  const QString &Text();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireSpecialSection(ShipRequestSpecialSectionEventParams *e) {...}

Remarks

The SpecialSection event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, while the SectionId parameter provides the section identifier (e.g. "CDATA").

SSLServerAuthentication Event (ShipRequest Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_SSLSERVERAUTHENTICATION 17

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

class ShipRequestSSLServerAuthenticationEventParams {
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(ShipRequestSSLServerAuthenticationEventParams *e);

// Or, subclass ShipRequest and override this emitter function.
virtual int FireSSLServerAuthentication(ShipRequestSSLServerAuthenticationEventParams *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 (ShipRequest Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_SSLSTATUS 18

virtual INT DSHIPPINGSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartElement Event (ShipRequest Class)

Fired when a begin-element tag is encountered in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartElement(ShipRequestStartElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} ShipRequestStartElementEventParams;


Unicode (Windows)
virtual INT FireStartElement(ShipRequestStartElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} ShipRequestStartElementEventParams;

#define EID_SHIPREQUEST_STARTELEMENT 19

virtual INT DSHIPPINGSDK_CALL FireStartElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class ShipRequestStartElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireStartElement(ShipRequestStartElementEventParams *e) {...}

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

StartPrefixMapping Event (ShipRequest Class)

Fired when entering the scope of a namespace declaration.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartPrefixMapping(ShipRequestStartPrefixMappingEventParams *e);

typedef struct {
  const char *Prefix;
  const char *URI;
  int reserved;
} ShipRequestStartPrefixMappingEventParams;


Unicode (Windows)
virtual INT FireStartPrefixMapping(ShipRequestStartPrefixMappingEventParams *e);

typedef struct {
  LPCWSTR Prefix;
  LPCWSTR URI;
  INT reserved;
} ShipRequestStartPrefixMappingEventParams;

#define EID_SHIPREQUEST_STARTPREFIXMAPPING 20

virtual INT DSHIPPINGSDK_CALL FireStartPrefixMapping(LPSTR &lpszPrefix, LPSTR &lpszURI);

class ShipRequestStartPrefixMappingEventParams {
public:
  const QString &Prefix();

  const QString &URI();

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

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

// Or, subclass ShipRequest and override this emitter function.
virtual int FireStartPrefixMapping(ShipRequestStartPrefixMappingEventParams *e) {...}

Remarks

The EndPrefixMapping event is fired when leaving the scope of a namespace declaration.

Status Event (ShipRequest Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHIPREQUEST_STATUS 21

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

class ShipRequestStatusEventParams {
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(ShipRequestStatusEventParams *e);

// Or, subclass ShipRequest and override this emitter function.
virtual int FireStatus(ShipRequestStatusEventParams *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").

Config Settings (ShipRequest Class)

ShipRequest Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (ShipRequest Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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

HTTP Errors