HttpResponse DataFlex Reference Documentation

HttpResponse

Current Version: 9.5.0.75

Represents a complete HTTP response.

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoHttpResponse
Get Create(RefClass(cComChilkatHttpResponse)) to hoHttpResponse

Properties

Body
Function ComBody Returns Variant

The response body returned as a byte array.

top
BodyQP
Function ComBodyQP Returns String

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

top
BodyStr
Function ComBodyStr Returns String

The response body returned as a string.

top
Charset
Function ComCharset Returns String

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

top
ContentLength
Function ComContentLength Returns Integer

The content length of the response, in bytes.

top
DateStr
Function ComDateStr Returns String

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

top
DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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
Function ComDomain Returns String

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
Function ComFinalRedirectUrl Returns String
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
Function ComFullMime Returns String

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

top
Header
Function ComHeader Returns String

The full text of the response header.

top
LastBinaryResult
Function ComLastBinaryResult Returns Variant
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 True. 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
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
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.

top
LastStringResult
Function ComLastStringResult Returns String
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 True. 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
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

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

top
NumCookies
Function ComNumCookies Returns Integer

The number of cookies included in the response.

top
NumHeaderFields
Function ComNumHeaderFields Returns Integer

The number of response header fields.

top
StatusCode
Function ComStatusCode Returns Integer

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
Function ComStatusLine Returns String

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

top
StatusText
Function ComStatusText Returns String
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
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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.

top
Version
Function ComVersion Returns String

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

top

Methods

GetBodyBd
Function ComGetBodyBd cComChilkatBinData binData Returns Boolean
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns True for success, False for failure.

top
GetBodySb
Function ComGetBodySb cComChilkatStringBuilder sb Returns Boolean
Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns True for success, False for failure.

top
GetCookieDomain
Function ComGetCookieDomain Integer index Returns 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 null on failure

top
GetCookieExpiresStr
Function ComGetCookieExpiresStr Integer index Returns 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 null on failure

top
GetCookieName
Function ComGetCookieName Integer index Returns 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 null on failure

top
GetCookiePath
Function ComGetCookiePath Integer index Returns 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 null on failure

top
GetCookieValue
Function ComGetCookieValue Integer index Returns 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 null on failure

top
GetHeaderField
Function ComGetHeaderField String fieldName Returns String

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

Returns null on failure

top
GetHeaderFieldAttr
Function ComGetHeaderFieldAttr String fieldName String attrName Returns String

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

Returns null on failure

top
GetHeaderName
Function ComGetHeaderName Integer index Returns 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 null on failure

top
GetHeaderValue
Function ComGetHeaderValue Integer index Returns 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 null on failure

top
LoadTaskResult
Function ComLoadTaskResult cComChilkatTask task Returns 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.

top
SaveBodyBinary
Function ComSaveBodyBinary String path Returns Boolean

Saves the body of the HTTP response to a file.

Returns True for success, False for failure.

top
SaveBodyText
Function ComSaveBodyText Boolean bCrlf String path Returns 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.

top
UrlEncParamValue
Function ComUrlEncParamValue String encodedParamString String paramName Returns 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 null on failure

top