HttpResponse C Reference Documentation

HttpResponse

Represents a complete HTTP response.

Create/Dispose

HCkHttpResponse CkHttpResponse_Create(void);

Creates an instance of the HCkHttpResponse object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkHttpResponse_Dispose(HCkHttpResponse handle);

Objects created by calling CkHttpResponse_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkHttpResponse_Dispose.

Properties

void CkHttpResponse_getBody(HCkHttpResponse cHandle, HCkByteData retval);

The response body returned as a byte array.

void CkHttpResponse_getBodyQP(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_bodyQP(HCkHttpResponse cHandle);

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

void CkHttpResponse_getBodyStr(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_bodyStr(HCkHttpResponse cHandle);

The response body returned as a string.

void CkHttpResponse_getCharset(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_charset(HCkHttpResponse cHandle);

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

unsigned long CkHttpResponse_getContentLength(HCkHttpResponse cHandle);

The content length of the response, in bytes.

__int64 CkHttpResponse_getContentLength64(HCkHttpResponse cHandle);

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

void CkHttpResponse_getDate(HCkHttpResponse cHandle, SYSTEMTIME * retval);

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 CkHttpResponse_getDateStr(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_dateStr(HCkHttpResponse cHandle);

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

void CkHttpResponse_getDebugLogFilePath(HCkHttpResponse cHandle, HCkString retval);

void CkHttpResponse_putDebugLogFilePath(HCkHttpResponse cHandle, const char *newVal);

const char *CkHttpResponse_debugLogFilePath(HCkHttpResponse cHandle);

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 CkHttpResponse_getDomain(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_domain(HCkHttpResponse cHandle);

The domain of the HTTP server that created this response.

void CkHttpResponse_getFinalRedirectUrl(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_finalRedirectUrl(HCkHttpResponse cHandle);

Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

void CkHttpResponse_getFullMime(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_fullMime(HCkHttpResponse cHandle);

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

void CkHttpResponse_getHeader(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_header(HCkHttpResponse cHandle);

The full text of the response header.

void CkHttpResponse_getLastErrorHtml(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_lastErrorHtml(HCkHttpResponse cHandle);

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 CkHttpResponse_getLastErrorText(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_lastErrorText(HCkHttpResponse cHandle);

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 CkHttpResponse_getLastErrorXml(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_lastErrorXml(HCkHttpResponse cHandle);

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 CkHttpResponse_getLastMethodSuccess(HCkHttpResponse cHandle);

void CkHttpResponse_putLastMethodSuccess(HCkHttpResponse cHandle, 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 CkHttpResponse_getNumCookies(HCkHttpResponse cHandle);

The number of cookies included in the response.

int CkHttpResponse_getNumHeaderFields(HCkHttpResponse cHandle);

The number of response header fields.

int CkHttpResponse_getStatusCode(HCkHttpResponse cHandle);

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 CkHttpResponse_getStatusLine(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_statusLine(HCkHttpResponse cHandle);

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

void CkHttpResponse_getStatusText(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_statusText(HCkHttpResponse cHandle);

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 CkHttpResponse_getUtf8(HCkHttpResponse cHandle);

void CkHttpResponse_putUtf8(HCkHttpResponse cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

BOOL CkHttpResponse_getVerboseLogging(HCkHttpResponse cHandle);

void CkHttpResponse_putVerboseLogging(HCkHttpResponse cHandle, 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 CkHttpResponse_getVersion(HCkHttpResponse cHandle, HCkString retval);

const char *CkHttpResponse_version(HCkHttpResponse cHandle);

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

Methods

BOOL CkHttpResponse_GetBodyBd(HCkHttpResponse cHandle, HCkBinData binData);

Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns TRUE for success, FALSE for failure.

BOOL CkHttpResponse_GetBodySb(HCkHttpResponse cHandle, HCkStringBuilder 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 CkHttpResponse_GetCookieDomain(HCkHttpResponse cHandle, int index, HCkString outStr);

const char *CkHttpResponse_getCookieDomain(HCkHttpResponse cHandle, 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 CkHttpResponse_GetCookieExpires(HCkHttpResponse cHandle, int index, SYSTEMTIME *outSysTime);

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 CkHttpResponse_GetCookieExpiresStr(HCkHttpResponse cHandle, int index, HCkString outStr);

const char *CkHttpResponse_getCookieExpiresStr(HCkHttpResponse cHandle, 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 CkHttpResponse_GetCookieName(HCkHttpResponse cHandle, int index, HCkString outStr);

const char *CkHttpResponse_getCookieName(HCkHttpResponse cHandle, 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 CkHttpResponse_GetCookiePath(HCkHttpResponse cHandle, int index, HCkString outStr);

const char *CkHttpResponse_getCookiePath(HCkHttpResponse cHandle, 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 CkHttpResponse_GetCookieValue(HCkHttpResponse cHandle, int index, HCkString outStr);

const char *CkHttpResponse_getCookieValue(HCkHttpResponse cHandle, 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 CkHttpResponse_GetHeaderField(HCkHttpResponse cHandle, const char *fieldName, HCkString outStr);

const char *CkHttpResponse_getHeaderField(HCkHttpResponse cHandle, const char *fieldName);

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

Returns TRUE for success, FALSE for failure.

BOOL CkHttpResponse_GetHeaderFieldAttr(HCkHttpResponse cHandle, const char *fieldName, const char *attrName, HCkString outStr);

const char *CkHttpResponse_getHeaderFieldAttr(HCkHttpResponse cHandle, const char *fieldName, const char *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 CkHttpResponse_GetHeaderName(HCkHttpResponse cHandle, int index, HCkString outStr);

const char *CkHttpResponse_getHeaderName(HCkHttpResponse cHandle, 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 CkHttpResponse_GetHeaderValue(HCkHttpResponse cHandle, int index, HCkString outStr);

const char *CkHttpResponse_getHeaderValue(HCkHttpResponse cHandle, 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 CkHttpResponse_LoadTaskResult(HCkHttpResponse cHandle, HCkTask 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 CkHttpResponse_SaveBodyBinary(HCkHttpResponse cHandle, const char *path);

Saves the body of the HTTP response to a file.

Returns TRUE for success, FALSE for failure.

BOOL CkHttpResponse_SaveBodyText(HCkHttpResponse cHandle, BOOL bCrlf, const char *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 CkHttpResponse_SaveLastError(HCkHttpResponse cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

BOOL CkHttpResponse_UrlEncParamValue(HCkHttpResponse cHandle, const char *encodedParamString, const char *paramName, HCkString outStr);

const char *CkHttpResponse_urlEncParamValue(HCkHttpResponse cHandle, const char *encodedParamString, const char *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.