TChilkatHttpResponse Delphi ActiveX Reference Documentation

TChilkatHttpResponse

Current Version: 9.5.0.73

Represents a complete HTTP response.

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. See also: ActiveX Registration Tutorial
  3. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) should be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

var
obj: TChilkatHttpResponse;
...
begin
obj := TChilkatHttpResponse.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

Body
property Body: OleVariant readonly

The response body returned as a byte array.

top
BodyQP
property BodyQP: WideString readonly

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

top
BodyStr
property BodyStr: WideString readonly

The response body returned as a string.

top
Charset
property Charset: WideString readonly

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

top
ContentLength
property ContentLength: Integer readonly

The content length of the response, in bytes.

top
Date
property Date: TDateTime readonly
This property is deprecated. It will be removed in a future version.

The Date response header field, returned in a date/time data type.

top
DateStr
property DateStr: WideString readonly

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

top
DebugLogFilePath
property DebugLogFilePath: WideString

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
property Domain: WideString readonly

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
property FinalRedirectUrl: WideString readonly
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
property FullMime: WideString readonly

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

top
Header
property Header: WideString readonly

The full text of the response header.

top
LastBinaryResult
property LastBinaryResult: OleVariant readonly
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
property LastErrorHtml: WideString readonly

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
property LastErrorText: WideString readonly

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
property LastErrorXml: WideString readonly

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
property LastMethodSuccess: Integer
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
property LastStringResult: WideString readonly
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
property LastStringResultLen: Integer readonly
Introduced in version 9.5.0.53

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

top
NumCookies
property NumCookies: Integer readonly

The number of cookies included in the response.

top
NumHeaderFields
property NumHeaderFields: Integer readonly

The number of response header fields.

top
StatusCode
property StatusCode: Integer readonly

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
property StatusLine: WideString readonly

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

top
StatusText
property StatusText: WideString readonly
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
property VerboseLogging: Integer

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
property Version: WideString readonly

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

top

Methods

GetBodyBd
function GetBodyBd(binData: TChilkatBinData): Integer;
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns 1 for success, 0 for failure.

top
GetBodySb
function GetBodySb(sb: TChilkatStringBuilder): Integer;
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
function GetCookieDomain(index: Integer): WideString;

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 a zero-length WideString on failure

top
GetCookieExpires
function GetCookieExpires(index: Integer): TDateTime;
This method is deprecated. It will be removed in a future version.

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.

top
GetCookieExpiresStr
function GetCookieExpiresStr(index: Integer): WideString;

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 a zero-length WideString on failure

top
GetCookieName
function GetCookieName(index: Integer): WideString;

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 a zero-length WideString on failure

top
GetCookiePath
function GetCookiePath(index: Integer): WideString;

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 a zero-length WideString on failure

top
GetCookieValue
function GetCookieValue(index: Integer): WideString;

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 a zero-length WideString on failure

top
GetHeaderField
function GetHeaderField(fieldName: WideString): WideString;

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

Returns a zero-length WideString on failure

top
GetHeaderFieldAttr
function GetHeaderFieldAttr(fieldName: WideString; attrName: WideString): WideString;

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

Returns a zero-length WideString on failure

top
GetHeaderName
function GetHeaderName(index: Integer): WideString;

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 a zero-length WideString on failure

top
GetHeaderValue
function GetHeaderValue(index: Integer): WideString;

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 a zero-length WideString on failure

top
LoadTaskResult
function LoadTaskResult(task: TChilkatTask): Integer;
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
function SaveBodyBinary(path: WideString): Integer;

Saves the body of the HTTP response to a file.

Returns 1 for success, 0 for failure.

top
SaveBodyText
function SaveBodyText(bCrlf: Integer; path: WideString): Integer;

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
function UrlEncParamValue(encodedParamString: WideString; paramName: WideString): WideString;

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 a zero-length WideString on failure

top