HttpResponse Unicode C Reference Documentation

HttpResponse

Current Version: 9.5.0.75

Represents a complete HTTP response.

Create/Dispose

HCkHttpResponseW instance = CkHttpResponseW_Create();
// ...
CkHttpResponseW_Dispose(instance);
HCkHttpResponseW CkHttpResponseW_Create(void);

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

void CkHttpResponseW_Dispose(HCkHttpResponseW handle);

Objects created by calling CkHttpResponseW_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 CkHttpResponseW_Dispose.

Properties

Body
void CkHttpResponseW_getBody(HCkHttpResponseW cHandle, HCkByteData retval);

The response body returned as a byte array.

top
BodyQP
void CkHttpResponseW_getBodyQP(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_bodyQP(HCkHttpResponseW cHandle);

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

top
BodyStr
void CkHttpResponseW_getBodyStr(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_bodyStr(HCkHttpResponseW cHandle);

The response body returned as a string.

top
Charset
void CkHttpResponseW_getCharset(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_charset(HCkHttpResponseW cHandle);

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

top
ContentLength
unsigned long CkHttpResponseW_getContentLength(HCkHttpResponseW cHandle);

The content length of the response, in bytes.

top
ContentLength64
__int64 CkHttpResponseW_getContentLength64(HCkHttpResponseW cHandle);

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

top
DateStr
void CkHttpResponseW_getDateStr(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_dateStr(HCkHttpResponseW cHandle);

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

top
DebugLogFilePath
void CkHttpResponseW_getDebugLogFilePath(HCkHttpResponseW cHandle, HCkString retval);
void CkHttpResponseW_putDebugLogFilePath(HCkHttpResponseW cHandle, const wchar_t *newVal);
const wchar_t *CkHttpResponseW_debugLogFilePath(HCkHttpResponseW 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.

top
Domain
void CkHttpResponseW_getDomain(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_domain(HCkHttpResponseW cHandle);

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
void CkHttpResponseW_getFinalRedirectUrl(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_finalRedirectUrl(HCkHttpResponseW cHandle);
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
void CkHttpResponseW_getFullMime(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_fullMime(HCkHttpResponseW cHandle);

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

top
Header
void CkHttpResponseW_getHeader(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_header(HCkHttpResponseW cHandle);

The full text of the response header.

top
LastErrorHtml
void CkHttpResponseW_getLastErrorHtml(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_lastErrorHtml(HCkHttpResponseW 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.

top
LastErrorText
void CkHttpResponseW_getLastErrorText(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_lastErrorText(HCkHttpResponseW 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.

top
LastErrorXml
void CkHttpResponseW_getLastErrorXml(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_lastErrorXml(HCkHttpResponseW 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.

top
LastMethodSuccess
BOOL CkHttpResponseW_getLastMethodSuccess(HCkHttpResponseW cHandle);
void CkHttpResponseW_putLastMethodSuccess(HCkHttpResponseW 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.

top
NumCookies
int CkHttpResponseW_getNumCookies(HCkHttpResponseW cHandle);

The number of cookies included in the response.

top
NumHeaderFields
int CkHttpResponseW_getNumHeaderFields(HCkHttpResponseW cHandle);

The number of response header fields.

top
StatusCode
int CkHttpResponseW_getStatusCode(HCkHttpResponseW 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.

top
StatusLine
void CkHttpResponseW_getStatusLine(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_statusLine(HCkHttpResponseW cHandle);

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

top
StatusText
void CkHttpResponseW_getStatusText(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_statusText(HCkHttpResponseW 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".

top
VerboseLogging
BOOL CkHttpResponseW_getVerboseLogging(HCkHttpResponseW cHandle);
void CkHttpResponseW_putVerboseLogging(HCkHttpResponseW 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.

top
Version
void CkHttpResponseW_getVersion(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_version(HCkHttpResponseW cHandle);

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

top

Methods

GetBodyBd
BOOL CkHttpResponseW_GetBodyBd(HCkHttpResponseW cHandle, HCkBinDataW binData);
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns TRUE for success, FALSE for failure.

top
GetBodySb
BOOL CkHttpResponseW_GetBodySb(HCkHttpResponseW cHandle, HCkStringBuilderW sb);
Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns TRUE for success, FALSE for failure.

top
GetCookieDomain
BOOL CkHttpResponseW_GetCookieDomain(HCkHttpResponseW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getCookieDomain(HCkHttpResponseW 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.

top
GetCookieExpiresStr
BOOL CkHttpResponseW_GetCookieExpiresStr(HCkHttpResponseW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getCookieExpiresStr(HCkHttpResponseW 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.

top
GetCookieName
BOOL CkHttpResponseW_GetCookieName(HCkHttpResponseW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getCookieName(HCkHttpResponseW 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.

top
GetCookiePath
BOOL CkHttpResponseW_GetCookiePath(HCkHttpResponseW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getCookiePath(HCkHttpResponseW 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.

top
GetCookieValue
BOOL CkHttpResponseW_GetCookieValue(HCkHttpResponseW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getCookieValue(HCkHttpResponseW 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.

top
GetHeaderField
BOOL CkHttpResponseW_GetHeaderField(HCkHttpResponseW cHandle, const wchar_t *fieldName, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getHeaderField(HCkHttpResponseW cHandle, const wchar_t *fieldName);

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

Returns TRUE for success, FALSE for failure.

top
GetHeaderFieldAttr
BOOL CkHttpResponseW_GetHeaderFieldAttr(HCkHttpResponseW cHandle, const wchar_t *fieldName, const wchar_t *attrName, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getHeaderFieldAttr(HCkHttpResponseW cHandle, 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.

top
GetHeaderName
BOOL CkHttpResponseW_GetHeaderName(HCkHttpResponseW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getHeaderName(HCkHttpResponseW 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.

top
GetHeaderValue
BOOL CkHttpResponseW_GetHeaderValue(HCkHttpResponseW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_getHeaderValue(HCkHttpResponseW 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.

top
LoadTaskResult
BOOL CkHttpResponseW_LoadTaskResult(HCkHttpResponseW cHandle, HCkTaskW 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.

top
SaveBodyBinary
BOOL CkHttpResponseW_SaveBodyBinary(HCkHttpResponseW cHandle, const wchar_t *path);

Saves the body of the HTTP response to a file.

Returns TRUE for success, FALSE for failure.

top
SaveBodyText
BOOL CkHttpResponseW_SaveBodyText(HCkHttpResponseW cHandle, 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.

top
SaveLastError
BOOL CkHttpResponseW_SaveLastError(HCkHttpResponseW cHandle, 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.

top
UrlEncParamValue
BOOL CkHttpResponseW_UrlEncParamValue(HCkHttpResponseW cHandle, const wchar_t *encodedParamString, const wchar_t *paramName, const wchar_t *outStr);
const wchar_t *CkHttpResponseW_urlEncParamValue(HCkHttpResponseW cHandle, 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.

top