CkHttpResponseW Unicode C++ Reference Documentation

CkHttpResponseW

Represents a complete HTTP response.

Properties

void get_Body(CkByteData &byteData);

The response body returned as a byte array.

void get_BodyQP(CkString &str);
const wchar_t *bodyQP(void);

The same as the Body property, but returned as a quoted-printable encoded string.

void get_BodyStr(CkString &str);
const wchar_t *bodyStr(void);

The response body returned as a string.

void get_Charset(CkString &str);
const wchar_t *charset(void);

The response charset, such as "iso-8859-1", if applicable. Obviously, responses for GIF and JPG files will not have a charset.

unsigned long get_ContentLength(void);

The content length of the response, in bytes.

__int64 get_ContentLength64(void);

The content length of the response, in number of bytes, returned as a 64-bit integer.

SYSTEMTIME & get_Date(void);

This property is deprecated. It will be removed in a future version.

The Date response header field, returned in a date/time data type.

void get_DateStr(CkString &str);
const wchar_t *dateStr(void);

Returns the content of the Date response header field in RFC822 date/time string format.

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

void get_Domain(CkString &str);
const wchar_t *domain(void);

The domain of the HTTP server that created this response.

void get_FinalRedirectUrl(CkString &str);
const wchar_t *finalRedirectUrl(void);

Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

void get_FullMime(CkString &str);
const wchar_t *fullMime(void);

Returns the full MIME (header + body) of the HTTP response.

void get_Header(CkString &str);
const wchar_t *header(void);

The full text of the response header.

void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

void get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

int get_NumCookies(void);

The number of cookies included in the response.

int get_NumHeaderFields(void);

The number of response header fields.

int get_StatusCode(void);

The status code (as an integer) from the first line of an HTTP response. If the StatusLine = "HTTP/1.0 200 OK", the response status code returned is 200.

void get_StatusLine(CkString &str);
const wchar_t *statusLine(void);

The first line of an HTTP response, such as "HTTP/1.0 200 OK".

void get_StatusText(CkString &str);
const wchar_t *statusText(void);

Introduced in version 9.5.0.49

The text that follows the status code in the 1st line of the HTTP response. For example, i the first line of an HTTP response is "HTTP/1.0 200 OK", then this property contains "OK".

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

void get_Version(CkString &str);
const wchar_t *version(void);

Version of the component/library, such as "9.5.0.63"

Methods

bool GetBodyBd(CkBinDataW &binData);

Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns true for success, false for failure.

bool GetBodySb(CkStringBuilderW &sb);

Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

bool GetCookieDomain(int index, CkString &outStr);
const wchar_t *getCookieDomain(int index);

Returns the domain of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

bool GetCookieExpires(int index, SYSTEMTIME &outSysTime);
const wchar_t *getCookieExpires(int index);

This method is deprecated. It will be removed in a future version.

Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

bool GetCookieExpiresStr(int index, CkString &outStr);
const wchar_t *getCookieExpiresStr(int index);

Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

bool GetCookieName(int index, CkString &outStr);
const wchar_t *getCookieName(int index);

Returns the name of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

bool GetCookiePath(int index, CkString &outStr);
const wchar_t *getCookiePath(int index);

Returns the path of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

bool GetCookieValue(int index, CkString &outStr);
const wchar_t *getCookieValue(int index);

Returns the value of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns true for success, false for failure.

bool GetHeaderField(const wchar_t *fieldName, CkString &outStr);
const wchar_t *getHeaderField(const wchar_t *fieldName);

Returns the value of a response header field accessed by field name.

Returns true for success, false for failure.

bool GetHeaderFieldAttr(const wchar_t *fieldName, const wchar_t *attrName, CkString &outStr);
const wchar_t *getHeaderFieldAttr(const wchar_t *fieldName, const wchar_t *attrName);

Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr("content-type","charset")

Returns true for success, false for failure.

bool GetHeaderName(int index, CkString &outStr);
const wchar_t *getHeaderName(int index);

Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns true for success, false for failure.

bool GetHeaderValue(int index, CkString &outStr);
const wchar_t *getHeaderValue(int index);

Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns true for success, false for failure.

bool LoadTaskResult(CkTaskW &task);

Introduced in version 9.5.0.52

Loads the HTTP response from a completed asynchronous task. A failed return value indicates that no HTTP response was received in the HTTP asynchronous method call (i.e. the asynchronous HTTP request failed in such a way that no response was received).

Returns true for success, false for failure.

Getting the HTTP Response after an Asynchronous HTTP Request Completes

bool SaveBodyBinary(const wchar_t *path);

Saves the body of the HTTP response to a file.

Returns true for success, false for failure.

bool SaveBodyText(bool bCrlf, const wchar_t *path);

Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If bCrlf is true, then line endings are automatically converted to CRLF if necessary. If bCrlf is false, then line-endings are automatically converted to bare-LF's (Unix style) if necessary.

To save the HTTP response body exactly as-is (with no line-ending manipulation), then call SaveBodyBinary.

Returns true for success, false for failure.

bool SaveLastError(const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

bool UrlEncParamValue(const wchar_t *encodedParamString, const wchar_t *paramName, CkString &outStr);
const wchar_t *urlEncParamValue(const wchar_t *encodedParamString, const wchar_t *paramName);

Convenience method for parsing a param's value out of a URL-encoded param string. For example, if a caller passes the following string in encodedParamString:

oauth_token=ABC&oauth_token_secret=123&oauth_callback_confirmed=true
and "oauth_token_secret" in paramName, then the return value would be "123".

Returns true for success, false for failure.