HTTP Class

Properties   Methods   Events   Config Settings   Errors  

The HTTP Class can be used to retrieve documents from the World Wide Web.

Syntax

HTTP

Remarks

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

The HTTP Class implements a standard HTTP client through a simple plug-and-play interface as defined in RFC 1945 and RFC 2616 with the added option of SSL security.

The class contains a number of properties that map directly to HTTP request headers. Files are received through two events: (1) Transfer for content, and (2) Header for HTTP headers. The StartTransfer and EndTransfer events are fired at the beginning and end of transmission.

To receive a document, call the Get method with the URL parameter. Data can be POST-ed to the HTTP server by assigning it to the PostData property and then calling the Post method.

The PUT method is also supported. You should specify the User and Password properties or alternatively the Authorization and call the Put method with the specified URL. The AttachedFile will be sent to the server.

The HTTP Class supports the HTTP Basic authentication scheme through the User and Password properties. Other authentication schemes can be implemented by using the AuthScheme property.

Property List

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

Method List

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

Event List

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

Config Settings

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

Accept Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getaccept(void* lpObj);
int ipworksssl_http_setaccept(void* lpObj, const char* lpszAccept);

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

Default Value

""

Remarks

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

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

Data Type

String

AllowHTTPCompression Property (HTTP Class)

This property enables HTTP compression for receiving data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAllowHTTPCompression();
int SetAllowHTTPCompression(int bAllowHTTPCompression);

Unicode (Windows)
BOOL GetAllowHTTPCompression();
INT SetAllowHTTPCompression(BOOL bAllowHTTPCompression);

int ipworksssl_http_getallowhttpcompression(void* lpObj);
int ipworksssl_http_setallowhttpcompression(void* lpObj, int bAllowHTTPCompression);

bool GetAllowHTTPCompression();
int SetAllowHTTPCompression(bool bAllowHTTPCompression);

Default Value

TRUE

Remarks

This property enables HTTP compression for receiving data. When set to True, the class will accept compressed data. It will then uncompress the data it has received. The class will handle data compressed by both gzip and Deflate compression algorithms.

When True, the class adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate".

TransferredData will contain the decompressed data received by the server, but the Transfer event will report exactly what is received by the server (compressed data).

Data Type

Boolean

AttachedFile Property (HTTP Class)

This property includes a file to append to PostData if the POST or PUT methods are used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFile();
wchar_t* GetAttachedFile_W(); // Windows only
int SetAttachedFile(const char* lpszAttachedFile);
int SetAttachedFile(const wchar_t* lpszAttachedFile); // Windows only

Unicode (Windows)
LPWSTR GetAttachedFile();
INT SetAttachedFile(LPCWSTR lpszAttachedFile);

char* ipworksssl_http_getattachedfile(void* lpObj);
wchar_t* ipworksssl_http_getattachedfile_W(void* lpObj); // Windows only
int ipworksssl_http_setattachedfile(void* lpObj, const char* lpszAttachedFile);
int ipworksssl_http_setattachedfile(void* lpObj, const wchar_t* lpszAttachedFile); // Windows only

QString GetAttachedFile();
int SetAttachedFile(QString qsAttachedFile);

Default Value

""

Remarks

If this property contains a nonempty string, then if the HTTP POST or PUT methods are used (through the Post or Put methods), the contents of this property are appended to the HTTP request after any data in PostData.

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

If data are being uploaded to a web service the WebUpload class is recommended because it will automatically encode file and form variables. Alternatively, the MIME class may be used to construct the raw MIME entity, which may be sent by this property.

This property is not available at design time.

Data Type

String

Authorization Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getauthorization(void* lpObj);
int ipworksssl_http_setauthorization(void* lpObj, const char* lpszAuthorization);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

AuthScheme Property (HTTP Class)

The authentication scheme to use when server authentication is required.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_http_getauthscheme(void* lpObj);
int ipworksssl_http_setauthscheme(void* lpObj, int iAuthScheme);

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

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

Connected Property (HTTP Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getconnected(void* lpObj);
int ipworksssl_http_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 (HTTP 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* ipworksssl_http_getcontenttype(void* lpObj);
int ipworksssl_http_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

CookieCount Property (HTTP Class)

The number of records in the Cookie arrays.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getcookiecount(void* lpObj);
int ipworksssl_http_setcookiecount(void* lpObj, int iCookieCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (HTTP Class)

This is the domain of a received cookie.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);

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

QString GetCookieDomain(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieExpiration Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);

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

QString GetCookieExpiration(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieName Property (HTTP Class)

This property, contains the name of the cookie.

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getcookiename(void* lpObj, int cookieindex);
int ipworksssl_http_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

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

Default Value

""

Remarks

This property, contains the name of the cookie.

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

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

This property is not available at design time.

Data Type

String

CookiePath Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);

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

QString GetCookiePath(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieSecure Property (HTTP Class)

This property contains the security flag of the received cookie.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);

int ipworksssl_http_getcookiesecure(void* lpObj, int cookieindex);

bool GetCookieSecure(int iCookieIndex);

Default Value

FALSE

Remarks

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

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

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

Data Type

Boolean

CookieValue Property (HTTP Class)

This property contains the value of the cookie.

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getcookievalue(void* lpObj, int cookieindex);
int ipworksssl_http_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

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

Default Value

""

Remarks

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

The SetCookie event provides the cookies set by the server.

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getfirewallautodetect(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_http_getfirewalltype(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getfirewallhost(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getfirewallpassword(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getfirewallport(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getfirewalluser(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_http_getfollowredirects(void* lpObj);
int ipworksssl_http_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

From Property (HTTP Class)

This property includes the email address of the HTTP agent (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFrom();
int SetFrom(const char* lpszFrom);

Unicode (Windows)
LPWSTR GetFrom();
INT SetFrom(LPCWSTR lpszFrom);

char* ipworksssl_http_getfrom(void* lpObj);
int ipworksssl_http_setfrom(void* lpObj, const char* lpszFrom);

QString GetFrom();
int SetFrom(QString qsFrom);

Default Value

""

Remarks

This property contains the email address of the HTTP agent (optional). If it contains a nonempty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

This property is not available at design time.

Data Type

String

HTTPMethod Property (HTTP 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* ipworksssl_http_gethttpmethod(void* lpObj);
int ipworksssl_http_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

HTTPVersion Property (HTTP Class)

This property includes the HTTP Version used by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHTTPVersion();
int SetHTTPVersion(const char* lpszHTTPVersion);

Unicode (Windows)
LPWSTR GetHTTPVersion();
INT SetHTTPVersion(LPCWSTR lpszHTTPVersion);

char* ipworksssl_http_gethttpversion(void* lpObj);
int ipworksssl_http_sethttpversion(void* lpObj, const char* lpszHTTPVersion);

QString GetHTTPVersion();
int SetHTTPVersion(QString qsHTTPVersion);

Default Value

"1.1"

Remarks

This property specifies the HTTP version used by the class. Possible values are as follows:

• "1.0"
• "1.1" (default)
• "2.0"
• "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

This property is not available at design time.

Data Type

String

Idle Property (HTTP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksssl_http_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getifmodifiedsince(void* lpObj);
int ipworksssl_http_setifmodifiedsince(void* lpObj, const char* lpszIfModifiedSince);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

LocalFile Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getlocalfile(void* lpObj);
wchar_t* ipworksssl_http_getlocalfile_W(void* lpObj); // Windows only
int ipworksssl_http_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

OtherHeaders Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

ParsedHeaderCount Property (HTTP Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

char* ipworksssl_http_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 (HTTP Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

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

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

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

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

Data Type

String

Password Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getpassword(void* lpObj);
int ipworksssl_http_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

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

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

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

Data Type

String

PostData Property (HTTP 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 ipworksssl_http_getpostdata(void* lpObj, char** lpPostData, int* lenPostData);
int ipworksssl_http_setpostdata(void* lpObj, const char* lpPostData, int lenPostData);

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

Default Value

""

Remarks

If this property has a nonempty string, then the HTTP Post method is used. The contents of this property are appended to the HTTP request after the HTTP headers.

An HTTP Content-Length header is added to the request. Its value is the length of the string in PostData, or, if the AttachedFile property has been set, its value is the cumulative length of the string and the file. See the description of the AttachedFile property for details.

If the goal is to upload a file or binary form data to a receiving script, the postdata must be MIME encoded. The WebUpload component is specifically designed for this and will perform all of the MIME encoding for you automatically. The WebForm component can be used for any form data posting.

Posting HTML form input data is the most common example of this property. In this 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

Pragma Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getpragma(void* lpObj);
int ipworksssl_http_setpragma(void* lpObj, const char* lpszPragma);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_http_getproxyauthscheme(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getproxyautodetect(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getproxypassword(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getproxyport(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getproxyserver(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_http_getproxyssl(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

Range Property (HTTP Class)

This property includes the byte-range to be sent to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRange();
int SetRange(const char* lpszRange);

Unicode (Windows)
LPWSTR GetRange();
INT SetRange(LPCWSTR lpszRange);

char* ipworksssl_http_getrange(void* lpObj);
int ipworksssl_http_setrange(void* lpObj, const char* lpszRange);

QString GetRange();
int SetRange(QString qsRange);

Default Value

""

Remarks

If this property contains a nonempty string, a Range HTTP request header is added to the request. This header tells the server to send only a certain range of bytes.

The format of this property consists of a range of bytes specified by two numbers separated by '-' (e.g., "0-499")

Following are examples of this format:

Data Type

String

Referer Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getreferer(void* lpObj);
int ipworksssl_http_setreferer(void* lpObj, const char* lpszReferer);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (HTTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksssl_http_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 (HTTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getsslcertstorepassword(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_http_getsslcertstoretype(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getsslcertsubject(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_http_getsslprovider(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStatusLine();

Unicode (Windows)
LPWSTR GetStatusLine();

char* ipworksssl_http_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 (HTTP Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_http_gettimeout(void* lpObj);
int ipworksssl_http_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 (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

QByteArray GetTransferredData();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

TransferredDataLimit Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

int64 ipworksssl_http_gettransferreddatalimit(void* lpObj);
int ipworksssl_http_settransferreddatalimit(void* lpObj, int64 lTransferredDataLimit);

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

Default Value

0

Remarks

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

Data Type

Long64

TransferredHeaders Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();

char* ipworksssl_http_gettransferredheaders(void* lpObj);

QString GetTransferredHeaders();

Default Value

""

Remarks

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

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

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

Data Type

String

URL Property (HTTP Class)

This property specifies the URL to fetch.

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_geturl(void* lpObj);
int ipworksssl_http_seturl(void* lpObj, const char* lpszURL);

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

Default Value

""

Remarks

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

Data Type

String

URLPath Property (HTTP Class)

This property specifies the path for the URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURLPath();
int SetURLPath(const char* lpszURLPath);

Unicode (Windows)
LPWSTR GetURLPath();
INT SetURLPath(LPCWSTR lpszURLPath);

char* ipworksssl_http_geturlpath(void* lpObj);
int ipworksssl_http_seturlpath(void* lpObj, const char* lpszURLPath);

QString GetURLPath();
int SetURLPath(QString qsURLPath);

Default Value

""

Remarks

This property contains the path for the URL. The URL path is determined by parsing the value set in the URL property.

This property is not available at design time.

Data Type

String

URLPort Property (HTTP Class)

This property specifies the port for the URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetURLPort();
int SetURLPort(int iURLPort);

Unicode (Windows)
INT GetURLPort();
INT SetURLPort(INT iURLPort);

int ipworksssl_http_geturlport(void* lpObj);
int ipworksssl_http_seturlport(void* lpObj, int iURLPort);

int GetURLPort();
int SetURLPort(int iURLPort);

Default Value

443

Remarks

This property contains the port for the URL. The HTTP server port is determined by parsing the value set in the URL property.

This property is not available at design time.

Data Type

Integer

URLScheme Property (HTTP Class)

This property includes the scheme for the URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURLScheme();
int SetURLScheme(const char* lpszURLScheme);

Unicode (Windows)
LPWSTR GetURLScheme();
INT SetURLScheme(LPCWSTR lpszURLScheme);

char* ipworksssl_http_geturlscheme(void* lpObj);
int ipworksssl_http_seturlscheme(void* lpObj, const char* lpszURLScheme);

QString GetURLScheme();
int SetURLScheme(QString qsURLScheme);

Default Value

"https"

Remarks

This property contains the scheme for the URL. The URL scheme is determined by parsing the value set in the URL property.

The supported schemes are "http" and "https".

This property is not available at design time.

Data Type

String

URLServer Property (HTTP Class)

This property specifies the server for the URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURLServer();
int SetURLServer(const char* lpszURLServer);

Unicode (Windows)
LPWSTR GetURLServer();
INT SetURLServer(LPCWSTR lpszURLServer);

char* ipworksssl_http_geturlserver(void* lpObj);
int ipworksssl_http_seturlserver(void* lpObj, const char* lpszURLServer);

QString GetURLServer();
int SetURLServer(QString qsURLServer);

Default Value

""

Remarks

This property contains the server for the URL. The HTTP server name is determined by parsing the value set in the URL property.

This property is not available at design time.

Data Type

String

User Property (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_http_getuser(void* lpObj);
int ipworksssl_http_setuser(void* lpObj, const char* lpszUser);

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

Default Value

""

Remarks

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

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

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

Data Type

String

AddCookie Method (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

Error Handling (C++)

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

CalcAuthorization Method (HTTP Class)

This method calculates the Authorization header based on provided credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CalcAuthorization();

Unicode (Windows)
INT CalcAuthorization();

int ipworksssl_http_calcauthorization(void* lpObj);

int CalcAuthorization();

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User, and Password.

In most cases, this method does not need to be called. The class will automatically calculate any required authorization values when a method is called, such as Get or Post.

This method may be useful in cases in which the Authorization value needs to be calculated before sending a request.

Error Handling (C++)

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

Config Method (HTTP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

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

Connect Method (HTTP Class)

This method connects to the remote host without performing any action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksssl_http_connect(void* lpObj);

int Connect();

Remarks

This method establishes a connection with the remote host specified by URL, but it does not send a request. In most cases, it is recommended to use the appropriate method, such as Get or Post, which will both establish a connection and send a request.

This method may be useful in cases in which it is desirable to establish a connection without performing any operation (e.g., when testing connectivity).

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

Delete Method (HTTP Class)

This method deletes an object on the server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Delete(LPCWSTR lpszURL);

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

int Delete(const QString& qsURL);

Remarks

This method is used to delete an object at the URL specified by using the HTTP DELETE method. The server response text is received through the Transfer event, and the HTTP response headers through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well. Normally, the user should have assigned correct values to User and Password or Authorization.

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

Disconnect Method (HTTP Class)

This method disconnects from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksssl_http_disconnect(void* lpObj);

int Disconnect();

Remarks

This method immediately disconnects from the server.

In most cases, the connection is closed automatically, and this method does not need to be called. Call the Disconnect method in cases in which it is desirable to immediately disconnect.

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

DoEvents Method (HTTP Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssl_http_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 (HTTP Class)

This 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 ipworksssl_http_get(void* lpObj, const char* lpszURL);

int Get(const QString& qsURL);

Remarks

This fetches the document using the HTTP GET method. The document contents are delivered through the Transfer event, and the HTTP response headers are delivered 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.)

Head Method (HTTP Class)

This fetches the document headers using the HTTP HEAD method.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Head(LPCWSTR lpszURL);

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

int Head(const QString& qsURL);

Remarks

This fetches the document headers using the HTTP HEAD method. The headers are received through the Header event.

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

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

Post Method (HTTP Class)

This method posts data to the HTTP server using the HTTP POST method.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Post(LPCWSTR lpszURL);

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

int Post(const QString& qsURL);

Remarks

This method posts data to the HTTP server using the HTTP POST method. Posted data are taken from PostData or AttachedFile properties. The server response text is received through the Transfer event, and the HTTP response headers are received through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well.

If the goal is to upload a file or binary form data to a receiving script, the postdata must be MIME encoded, or you should use the WebUpload or WEBFORM component.

Example. Performing a Post:

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

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

Put Method (HTTP Class)

This method sends data to the HTTP server using the HTTP PUT method.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Put(LPCWSTR lpszURL);

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

int Put(const QString& qsURL);

Remarks

This method sends data to the HTTP server. The data are taken from PostData or AttachedFile properties. The server response text is received through the Transfer event, and the HTTP response headers are received through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well. The user normally should have assigned the correct values to User and Password or Authorization.

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

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssl_http_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

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

ResetHeaders Method (HTTP Class)

This method resets all HTTP headers, cookies, LocalFile , and AttachedFile .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetHeaders();

Unicode (Windows)
INT ResetHeaders();

int ipworksssl_http_resetheaders(void* lpObj);

int ResetHeaders();

Remarks

This method resets all the HTTP headers as well as LocalFile and AttachedFile to "" (empty string). It also resets the cookie properties. Use this method before creating a new request to ensure that headers from the previous message are not carried over to the next one.

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

SetDownloadStream Method (HTTP Class)

This method sets the stream to which the downloaded data from the server will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDownloadStream(IPWorksSSLStream* sDownloadStream);

Unicode (Windows)
INT SetDownloadStream(IPWorksSSLStream* sDownloadStream);

int ipworksssl_http_setdownloadstream(void* lpObj, IPWorksSSLStream* sDownloadStream);

int SetDownloadStream(IPWorksSSLStream* sDownloadStream);

Remarks

This method sets the stream to which the downloaded data from the server will be written. If a download stream is set before the Get method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetDownloadStream again before calling Get again. The downloaded content will be written starting at the current position in the stream.

Note: SetDownloadStream and LocalFile will reset the other.

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

SetUploadStream Method (HTTP Class)

This method sets the stream to be uploaded to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUploadStream(IPWorksSSLStream* sUploadStream);

Unicode (Windows)
INT SetUploadStream(IPWorksSSLStream* sUploadStream);

int ipworksssl_http_setuploadstream(void* lpObj, IPWorksSSLStream* sUploadStream);

int SetUploadStream(IPWorksSSLStream* sUploadStream);

Remarks

This method sets the stream to be uploaded to the server. If an upload stream is set before the Post or Put method are called, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetUploadStream again before calling Post or Put again. The content of the stream will be read from the current position all the way to the end.

Note: SetUploadStream and LocalFile will reset the other.

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

Connected Event (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_CONNECTED 1

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

class HTTPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_CONNECTIONSTATUS 2

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

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

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

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_DISCONNECTED 3

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

class HTTPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (HTTP Class)

This event is fired when a document finishes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_ENDTRANSFER 4

virtual INT IPWORKSSSL_CALL FireEndTransfer(INT &iDirection);

class HTTPEndTransferEventParams {
public:
  int Direction();

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

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

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

Remarks

The EndTransfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

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

Error Event (HTTP Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_ERROR 5

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

class HTTPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

Header Event (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_HEADER 6

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

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

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

Remarks

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

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

Log Event (HTTP Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_LOG 7

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

class HTTPLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

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

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

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

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (HTTP Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_REDIRECT 8

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

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

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

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_SETCOOKIE 9

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

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

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

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (HTTP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_SSLSERVERAUTHENTICATION 10

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

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

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

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_SSLSTATUS 11

virtual INT IPWORKSSSL_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartTransfer Event (HTTP Class)

This event is fired when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_HTTP_STARTTRANSFER 12

virtual INT IPWORKSSSL_CALL FireStartTransfer(INT &iDirection);

class HTTPStartTransferEventParams {
public:
  int Direction();

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

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

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

Remarks

The StartTransfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

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

Status Event (HTTP 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(HTTPStatusEventParams *e);

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


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

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

#define EID_HTTP_STATUS 13

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

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

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

Remarks

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

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

Transfer Event (HTTP Class)

This event is fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} HTTPTransferEventParams;


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

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} HTTPTransferEventParams;

#define EID_HTTP_TRANSFER 14

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

class HTTPTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

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

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

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

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

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

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

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

IPWorksSSLStream Type

Syntax

IPWorksSSLStream (declared in ipworksssl.h)

Remarks

The HTTP class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksSSLStream interface and pass the HTTP class an instance of that concrete class.

When implementing the IPWorksSSLStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (HTTP Class)

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