HttpResponse PureBasic Reference Documentation

HttpResponse

Current Version: 9.5.0.73

Represents a complete HTTP response.

Object Creation

obj.i = CkHttpResponse::ckCreate()

; Make sure to dispose of the object when finished like this:
CkHttpResponse::ckDispose(obj);

Properties

BodyQP
Declare.s ckBodyQP(obj.i) ; (read-only)

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

top
BodyStr
Declare.s ckBodyStr(obj.i) ; (read-only)

The response body returned as a string.

top
Charset
Declare.s ckCharset(obj.i) ; (read-only)

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

top
ContentLength
Declare.i ckContentLength(obj.i) ; (read-only)

The content length of the response, in bytes.

top
DateStr
Declare.s ckDateStr(obj.i) ; (read-only)

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

top
DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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
Declare.s ckDomain(obj.i) ; (read-only)

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
Declare.s ckFinalRedirectUrl(obj.i) ; (read-only)
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
Declare.s ckFullMime(obj.i) ; (read-only)

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

top
Header
Declare.s ckHeader(obj.i) ; (read-only)

The full text of the response header.

top
LastErrorHtml
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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
Declare.s ckLastErrorText(obj.i) ; (read-only)

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
Declare.s ckLastErrorXml(obj.i) ; (read-only)

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
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumCookies
Declare.i ckNumCookies(obj.i) ; (read-only)

The number of cookies included in the response.

top
NumHeaderFields
Declare.i ckNumHeaderFields(obj.i) ; (read-only)

The number of response header fields.

top
StatusCode
Declare.i ckStatusCode(obj.i) ; (read-only)

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
Declare.s ckStatusLine(obj.i) ; (read-only)

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

top
StatusText
Declare.s ckStatusText(obj.i) ; (read-only)
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
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

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

top

Methods

GetBodyBd
Declare.i ckGetBodyBd(obj.i, binData.i)
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns 1 for success, 0 for failure.

top
GetBodySb
Declare.i ckGetBodySb(obj.i, sb.i)
Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns 1 for success, 0 for failure.

top
GetCookieDomain
Declare.s ckGetCookieDomain(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetCookieExpiresStr
Declare.s ckGetCookieExpiresStr(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetCookieName
Declare.s ckGetCookieName(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetCookiePath
Declare.s ckGetCookiePath(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetCookieValue
Declare.s ckGetCookieValue(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetHeaderField
Declare.s ckGetHeaderField(obj.i, fieldName.s)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetHeaderFieldAttr
Declare.s ckGetHeaderFieldAttr(obj.i, fieldName.s, attrName.s)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetHeaderName
Declare.s ckGetHeaderName(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetHeaderValue
Declare.s ckGetHeaderValue(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
LoadTaskResult
Declare.i ckLoadTaskResult(obj.i, task.i)
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 1 for success, 0 for failure.

top
SaveBodyBinary
Declare.i ckSaveBodyBinary(obj.i, path.s)

Saves the body of the HTTP response to a file.

Returns 1 for success, 0 for failure.

top
SaveBodyText
Declare.i ckSaveBodyText(obj.i, bCrlf.l, path.s)

Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If bCrlf is 1, then line endings are automatically converted to CRLF if necessary. If bCrlf is 0, 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 1 for success, 0 for failure.

top
SaveLastError
Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.

top
UrlEncParamValue
Declare.s ckUrlEncParamValue(obj.i, encodedParamString.s, paramName.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top