HttpResponse ActiveX Reference Documentation
HttpResponse
Current Version: 10.1.2
Represents a complete HTTP response.
Object Creation
Note: For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.HttpResponse" instead of "Chilkat.HttpResponse" For a specific major version, use "Chilkat.HttpResponse.<major_version>", such as "Chilkat.HttpResponse.10" for Chilkat v10.*.* See Chilkat ActiveX Object Creation (ASP) set obj = Server.CreateObject("Chilkat.HttpResponse") (AutoIt) $obj = ObjCreate("Chilkat.HttpResponse") (Visual Basic 6.0) Dim obj As New ChilkatHttpResponse (VBScript) set obj = CreateObject("Chilkat.HttpResponse") (Delphi) obj := TChilkatHttpResponse.Create(Self); (FoxPro) loObject = CreateObject('Chilkat.HttpResponse') (PowerBuilder) lole_object = create oleobject li_rc = lole_object.ConnectToNewObject("Chilkat.HttpResponse") (SQL Server) EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @obj OUT (Javascript) var obj = new ActiveXObject("Chilkat.HttpResponse");
Properties
Body
The response body returned as a byte array.
topBodyQP
The same as the Body property, but returned as a quoted-printable encoded string.
topBodyStr
The response body returned as a string.
topCharset
The response charset, such as "iso-8859-1", if applicable. Obviously, responses for GIF and JPG files will not have a charset.
topContentLength
The content length of the response, in bytes.
topDateStr
Returns the content of the Date response header field in RFC822 date/time string format.
topDebugLogFilePath
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.
Domain
The domain of the HTTP server that created this response.
topFinalRedirectUrl
Returns the redirect URL for 301/302 responses.
topFullMime
Returns the full MIME (header + body) of the HTTP response.
Header
The full text of the response header.
topLastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
topLastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumCookies
The number of cookies included in the response.
topNumHeaderFields
The number of response header fields.
topStatusCode
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.
topStatusLine
The first line of an HTTP response, such as "HTTP/1.0 200 OK".
topStatusText
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".
topUncommonOptions
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
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.
topVersion
Version of the component/library, such as "10.1.0"
Methods
GetBodyBd
Copies the response body to a BinData object.
Returns 1 for success, 0 for failure.
GetBodyJarr
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 1 for success, 0 for failure.
GetBodyJson
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 1 for success, 0 for failure.
GetBodySb
Copies the response body to a Chilkat StringBuilder object.
Returns 1 for success, 0 for failure.
topGetBodyXml
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 1 for success, 0 for failure.
GetCookieDomain
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
topGetCookieExpiresStr
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
topGetCookieName
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
topGetCookiePath
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
topGetCookieValue
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
topGetHeaderField
GetHeaderFieldAttr
Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr("content-type","charset")
Returns Nothing on failure
topGetHeaderName
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
topGetHeaderValue
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
topLoadTaskResult
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.
SaveBodyBinary
Saves the body of the HTTP response to a file.
Returns 1 for success, 0 for failure.
SaveBodyText
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.
topUrlEncParamValue
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=trueand "oauth_token_secret" in paramName, then the return value would be "123".
Returns Nothing on failure
top