HttpResponse Xojo Plugin Reference Documentation

HttpResponse

Represents a complete HTTP response.

Object Creation

Dim httpResponse As New Chilkat.HttpResponse

Properties

Body As MemoryBlock (read-only)

The response body returned as a byte array.

BodyQP As String (read-only)

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

BodyStr As String (read-only)

The response body returned as a string.

Charset As String (read-only)

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

ContentLength As UInt32 (read-only)

The content length of the response, in bytes.

DateStr As String (read-only)

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

DebugLogFilePath As String

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.

Domain As String (read-only)

The domain of the HTTP server that created this response.

FinalRedirectUrl As String (read-only)

Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

FullMime As String (read-only)

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

Header As String (read-only)

The full text of the response header.

LastErrorHtml As String (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.

LastErrorText As String (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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (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.

LastMethodSuccess As Boolean

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.

NumCookies As Int32 (read-only)

The number of cookies included in the response.

NumHeaderFields As Int32 (read-only)

The number of response header fields.

StatusCode As Int32 (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.

StatusLine As String (read-only)

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

StatusText As String (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".

VerboseLogging As Boolean

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 As String (read-only)

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

Methods

Function GetBodyBd(binData As Chilkat.BinData) As Boolean

Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns True for success, False for failure.

Function GetBodySb(sb As Chilkat.StringBuilder) As Boolean

Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns True for success, False for failure.

Function GetCookieDomain(index As Int32) As String

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 Nil on failure

Function GetCookieExpiresStr(index As Int32) As String

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 Nil on failure

Function GetCookieName(index As Int32) As String

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 Nil on failure

Function GetCookiePath(index As Int32) As String

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 Nil on failure

Function GetCookieValue(index As Int32) As String

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 Nil on failure

Function GetHeaderField(fieldName As String) As String

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

Returns Nil on failure

Function GetHeaderFieldAttr(fieldName As String, attrName As String) As String

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

Returns Nil on failure

Function GetHeaderName(index As Int32) As String

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 Nil on failure

Function GetHeaderValue(index As Int32) As String

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 Nil on failure

Function LoadTaskResult(task As Chilkat.Task) As Boolean

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

Function SaveBodyBinary(path As String) As Boolean

Saves the body of the HTTP response to a file.

Returns True for success, False for failure.

Function SaveBodyText(bCrlf As Boolean, path As String) As Boolean

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.

Function SaveLastError(path As String) As Boolean

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

Returns True for success, False for failure.

Function UrlEncParamValue(encodedParamString As String, paramName As String) As String

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 Nil on failure