HttpResponse C Reference Documentation
HttpResponse
Current Version: 10.0.0
Represents a complete HTTP response.
Create/Dispose
HCkHttpResponse instance = CkHttpResponse_Create(); // ... CkHttpResponse_Dispose(instance);
Creates an instance of the HCkHttpResponse object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
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
Body
The response body returned as a byte array.
topBodyQP
const char *CkHttpResponse_bodyQP(HCkHttpResponse cHandle);
The same as the Body property, but returned as a quoted-printable encoded string.
topBodyStr
const char *CkHttpResponse_bodyStr(HCkHttpResponse cHandle);
The response body returned as a string.
topCharset
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.
topContentLength
The content length of the response, in bytes.
topContentLength64
The content length of the response, in number of bytes, returned as a 64-bit integer.
topDateStr
const char *CkHttpResponse_dateStr(HCkHttpResponse cHandle);
Returns the content of the Date response header field in RFC822 date/time string format.
topDebugLogFilePath
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
Domain
const char *CkHttpResponse_domain(HCkHttpResponse cHandle);
The domain of the HTTP server that created this response.
topFinalRedirectUrl
const char *CkHttpResponse_finalRedirectUrl(HCkHttpResponse cHandle);
Returns the redirect URL for 301/302 responses.
topFullMime
const char *CkHttpResponse_fullMime(HCkHttpResponse cHandle);
Header
const char *CkHttpResponse_header(HCkHttpResponse cHandle);
The full text of the response header.
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
void CkHttpResponse_putLastMethodSuccess(HCkHttpResponse cHandle, BOOL newVal);
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.
topNumCookies
The number of cookies included in the response.
topNumHeaderFields
The number of response header fields.
topStatusCode
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.
topStatusLine
const char *CkHttpResponse_statusLine(HCkHttpResponse cHandle);
The first line of an HTTP response, such as "HTTP/1.0 200 OK".
topStatusText
const char *CkHttpResponse_statusText(HCkHttpResponse cHandle);
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".
topUncommonOptions
void CkHttpResponse_putUncommonOptions(HCkHttpResponse cHandle, const char *newVal);
const char *CkHttpResponse_uncommonOptions(HCkHttpResponse cHandle);
This is a catch-all property to be used for uncommon needs. Can be set to a list of the following comma separated keywords:
- "TakeResponseBody" - Introduced in v9.5.0.89. The GetBody* methods will transfer the body to the target object instead of copying the contents. This can be useful if the response body is extremely large because it will reduce the overall memory requirement.
Utf8
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.
topVerboseLogging
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.
topVersion
const char *CkHttpResponse_version(HCkHttpResponse cHandle);
Methods
GetBodyBd
Copies the response body to a BinData object.
Returns TRUE for success, FALSE for failure.
GetBodyJarr
Loads the JSON array response body into a JsonArray This method should only be called when it is known that the response body contains a JSON array (beginning with a square bracket '[' and ending with a square bracket ']')
Returns TRUE for success, FALSE for failure.
GetBodyJson
Loads the JSON response body into a JsonObject. This method should only be called when it is known that the response body contains JSON (beginning with a curly brace '{' and ending with a curly brace '}')
Returns TRUE for success, FALSE for failure.
GetBodySb
Copies the response body to a Chilkat StringBuilder object.
Returns TRUE for success, FALSE for failure.
topGetBodyXml
Loads the XML response body into an XML object. This method should only be called when it is known that the response body contains XML.
Returns TRUE for success, FALSE for failure.
GetCookieDomain
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.
topGetCookieExpiresStr
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.
topGetCookieName
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.
topGetCookiePath
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.
topGetCookieValue
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.
topGetHeaderField
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.
topGetHeaderFieldAttr
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.
topGetHeaderName
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.
topGetHeaderValue
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.
topLoadTaskResult
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.
SaveBodyBinary
Saves the body of the HTTP response to a file.
Returns TRUE for success, FALSE for failure.
SaveBodyText
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.
topUrlEncParamValue
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=trueand "oauth_token_secret" in paramName, then the return value would be "123".
Returns TRUE for success, FALSE for failure.
top