HttpResponse Unicode C Reference Documentation

HttpResponse

Current Version: 10.1.2

Requires Chilkat Bundle License

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.

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.

BodyStr

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

The response body returned as a string.

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.

ContentLength

unsigned long CkHttpResponseW_getContentLength(HCkHttpResponseW cHandle);

The content length of the response, in bytes.

ContentLength64

__int64 CkHttpResponseW_getContentLength64(HCkHttpResponseW cHandle);

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

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.

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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

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.

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.

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.

More Information and Examples

How to Access Parts of a multipart/related HTTP Response

Header

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

The full text of the response header.

LastErrorHtml

void CkHttpResponseW_getLastErrorHtml(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_lastErrorHtml(HCkHttpResponseW cHandle);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void CkHttpResponseW_getLastErrorText(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_lastErrorText(HCkHttpResponseW cHandle);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkHttpResponseW_getLastErrorXml(HCkHttpResponseW cHandle, HCkString retval);
const wchar_t *CkHttpResponseW_lastErrorXml(HCkHttpResponseW cHandle);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

BOOL CkHttpResponseW_getLastMethodSuccess(HCkHttpResponseW cHandle);
void CkHttpResponseW_putLastMethodSuccess(HCkHttpResponseW cHandle, BOOL newVal);

Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumCookies

int CkHttpResponseW_getNumCookies(HCkHttpResponseW cHandle);

The number of cookies included in the response.

NumHeaderFields

int CkHttpResponseW_getNumHeaderFields(HCkHttpResponseW cHandle);

The number of response header fields.

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.

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

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

UncommonOptions

void CkHttpResponseW_getUncommonOptions(HCkHttpResponseW cHandle, HCkString retval);
void CkHttpResponseW_putUncommonOptions(HCkHttpResponseW cHandle, const wchar_t *newVal);
const wchar_t *CkHttpResponseW_uncommonOptions(HCkHttpResponseW cHandle);

Introduced in version 9.5.0.89

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.

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.

Version

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

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

More Information and Examples

How to get the Chilkat version at runtime.

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.

More Information and Examples

Parse Multipart Binary Http Response

GetBodyJarr

BOOL CkHttpResponseW_GetBodyJarr(HCkHttpResponseW cHandle, HCkJsonArrayW jarr);

Introduced in version 9.5.0.89

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.

More Information and Examples

Load JSON Array from HTTP Response Body

GetBodyJson

BOOL CkHttpResponseW_GetBodyJson(HCkHttpResponseW cHandle, HCkJsonObjectW json);

Introduced in version 9.5.0.89

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.

More Information and Examples

Load JSON Object from HTTP Response Body

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.

GetBodyXml

BOOL CkHttpResponseW_GetBodyXml(HCkHttpResponseW cHandle, HCkXmlW xml);

Introduced in version 9.5.0.89

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.

More Information and Examples

Load XML Object from HTTP Response Body

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

More Information and Examples

Getting the HTTP Response after an Asynchronous HTTP Request Completes

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.

More Information and Examples

IBM Cloud - Text to Speech - Synthesize Audio (POST)

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.

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.