HttpResponse ActiveX Reference Documentation

HttpResponse

Current Version: 9.5.0.75

Represents a complete HTTP response.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatHttpResponse

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.HttpResponse")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.HttpResponse")

(Delphi)
obj := TChilkatHttpResponse.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.HttpResponse')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.HttpResponse")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.HttpResponse', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.HttpResponse");

Properties

Body
Body As Variant (read-only)

The response body returned as a byte array.

top
BodyQP
BodyQP As String (read-only)

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

top
BodyStr
BodyStr As String (read-only)

The response body returned as a string.

top
Charset
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.

top
ContentLength
ContentLength As Long (read-only)

The content length of the response, in bytes.

top
DateStr
DateStr As String (read-only)

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

top
DebugLogFilePath
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.

top
Domain
Domain As String (read-only)

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
FinalRedirectUrl As String (read-only)
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
FullMime As String (read-only)

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

top
Header
Header As String (read-only)

The full text of the response header.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
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.

top
LastErrorText
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.

top
LastErrorXml
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.

top
LastMethodSuccess
LastMethodSuccess As Long
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
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
NumCookies
NumCookies As Long (read-only)

The number of cookies included in the response.

top
NumHeaderFields
NumHeaderFields As Long (read-only)

The number of response header fields.

top
StatusCode
StatusCode As Long (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
StatusLine As String (read-only)

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

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

top
VerboseLogging
VerboseLogging As Long

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

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

top

Methods

GetBodyBd
GetBodyBd(binData As ChilkatBinData) As Long
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns 1 for success, 0 for failure.

top
GetBodySb
GetBodySb(sb As ChilkatStringBuilder) As Long
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
GetCookieDomain(ByVal index As Long) 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 Nothing on failure

top
GetCookieExpiresStr
GetCookieExpiresStr(ByVal index As Long) 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 Nothing on failure

top
GetCookieName
GetCookieName(ByVal index As Long) 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 Nothing on failure

top
GetCookiePath
GetCookiePath(ByVal index As Long) 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 Nothing on failure

top
GetCookieValue
GetCookieValue(ByVal index As Long) 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 Nothing on failure

top
GetHeaderField
GetHeaderField(fieldName As String) As String

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

Returns Nothing on failure

top
GetHeaderFieldAttr
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 Nothing on failure

top
GetHeaderName
GetHeaderName(ByVal index As Long) 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 Nothing on failure

top
GetHeaderValue
GetHeaderValue(ByVal index As Long) 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 Nothing on failure

top
LoadTaskResult
LoadTaskResult(task As ChilkatTask) As Long
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
SaveBodyBinary(path As String) As Long

Saves the body of the HTTP response to a file.

Returns 1 for success, 0 for failure.

top
SaveBodyText
SaveBodyText(ByVal bCrlf As Long, path As String) As Long

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
UrlEncParamValue
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 Nothing on failure

top