---
product: Chilkat
product_version: 11.7.0
language: delphix
language_label: Delphi ActiveX
class: HttpResponse
class_name: TChilkatHttpResponse
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/delphiHttpResponseRef.html
---
# Chilkat HttpResponse — Delphi ActiveX — v11.7.0

> Chilkat 11.7.0 · language=delphix · class=HttpResponse (TChilkatHttpResponse)
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/HttpResponse.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/guide.md`.

## Purpose

**Inspect HTTP status, headers, cookies, redirects, and response bodies.**

`Chilkat.HttpResponse` represents an HTTP response returned by certain `Chilkat.Http` methods. It provides access to the response status line, status code, headers, cookies, charset, content length, body bytes, body text, full MIME response, redirect URL, and helper methods for saving or loading the response body into Chilkat objects such as `BinData`, `StringBuilder`, `JsonObject`, `JsonArray`, and `Xml`.

**Status and reason**

Read the HTTP status code, status line, and related response information to determine whether the request succeeded, redirected, or failed.

**Headers and cookies**

Inspect response headers, retrieve individual header values, and access cookies returned by the server.

**Body as text or bytes**

Get the response body as raw bytes or decoded text, using the response charset information when appropriate.

**Structured body loading**

Load the body directly into `JsonObject`, `JsonArray`, `Xml`, `BinData`, or `StringBuilder` objects for further processing.

**Redirect information**

Access redirect-related information such as the redirect URL when the server responds with a redirect status.

**Save and inspect responses**

Save body content, inspect the full MIME-style response, and use response metadata for diagnostics, logging, or API troubleshooting.

**Common pattern:** Send a request with `Chilkat.Http`, check the `StatusCode`, inspect headers or cookies as needed, then retrieve the body in the form best suited to the response content: text, bytes, `BinData`, `StringBuilder`, JSON, or XML. Use `HttpResponse` for response inspection; use `Chilkat.Http` for the actual network request.

For an extended overview, see [HttpResponse Class Overview](https://www.chilkatsoft.com/httpresponse_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

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

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Delphi ActiveX.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `property DebugLogFilePath: WideString` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `property LastBinaryResult: OleVariant readonly` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `property LastErrorHtml: WideString readonly` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `property LastErrorText: WideString readonly` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `property LastErrorXml: WideString readonly` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `property LastMethodSuccess: Integer` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `property LastStringResult: WideString readonly` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `property LastStringResultLen: Integer readonly` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `property VerboseLogging: Integer` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `property Version: WideString readonly` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Body` | property, read-only | `property Body: OleVariant readonly` |
| `BodyQP` | property, read-only | `property BodyQP: WideString readonly` |
| `BodyStr` | property, read-only | `property BodyStr: WideString readonly` |
| `Charset` | property, read-only | `property Charset: WideString readonly` |
| `ContentLength` | property, read-only | `property ContentLength: Integer readonly` |
| `DateStr` | property, read-only | `property DateStr: WideString readonly` |
| `Domain` | property, read-only | `property Domain: WideString readonly` |
| `FinalRedirectUrl` | property, read-only | `property FinalRedirectUrl: WideString readonly` |
| `FullMime` | property, read-only | `property FullMime: WideString readonly` |
| `Header` | property, read-only | `property Header: WideString readonly` |
| `NumCookies` | property, read-only | `property NumCookies: Integer readonly` |
| `NumHeaderFields` | property, read-only | `property NumHeaderFields: Integer readonly` |
| `StatusCode` | property, read-only | `property StatusCode: Integer readonly` |
| `StatusLine` | property, read-only | `property StatusLine: WideString readonly` |
| `StatusText` | property, read-only | `property StatusText: WideString readonly` |
| `UncommonOptions` | property, read/write | `property UncommonOptions: WideString` |
| `GetBodyBd` | method | `function GetBodyBd(binData: IChilkatBinData): Integer;` |
| `GetBodyJarr` | method | `function GetBodyJarr(jarr: IChilkatJsonArray): Integer;` |
| `GetBodyJson` | method | `function GetBodyJson(json: IChilkatJsonObject): Integer;` |
| `GetBodySb` | method | `function GetBodySb(sb: IChilkatStringBuilder): Integer;` |
| `GetBodyXml` | method | `function GetBodyXml(xml: IChilkatXml): Integer;` |
| `GetCookieDomain` | method | `function GetCookieDomain(index: Integer): WideString;` |
| `GetCookieExpiresStr` | method | `function GetCookieExpiresStr(index: Integer): WideString;` |
| `GetCookieName` | method | `function GetCookieName(index: Integer): WideString;` |
| `GetCookiePath` | method | `function GetCookiePath(index: Integer): WideString;` |
| `GetCookieValue` | method | `function GetCookieValue(index: Integer): WideString;` |
| `GetHeaderField` | method | `function GetHeaderField(fieldName: WideString): WideString;` |
| `GetHeaderFieldAttr` | method | `function GetHeaderFieldAttr(fieldName: WideString; attrName: WideString): WideString;` |
| `GetHeaderName` | method | `function GetHeaderName(index: Integer): WideString;` |
| `GetHeaderValue` | method | `function GetHeaderValue(index: Integer): WideString;` |
| `LoadTaskResult` | method | `function LoadTaskResult(task: IChilkatTask): Integer;` |
| `SaveBodyBinary` | method | `function SaveBodyBinary(path: WideString): Integer;` |
| `SaveBodyText` | method | `function SaveBodyText(bCrlf: Integer; path: WideString): Integer;` |
| `UrlEncParamValue` | method | `function UrlEncParamValue(encodedParamString: WideString; paramName: WideString): WideString;` |

## Properties

### HttpResponse.Body

`Chilkat 11.7.0 · delphix · HttpResponse · Body · property · read-only`

```pascal
property Body: OleVariant readonly
```

The response body returned as a byte array.

### HttpResponse.BodyQP

`Chilkat 11.7.0 · delphix · HttpResponse · BodyQP · property · read-only`

```pascal
property BodyQP: WideString readonly
```

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

### HttpResponse.BodyStr

`Chilkat 11.7.0 · delphix · HttpResponse · BodyStr · property · read-only`

```pascal
property BodyStr: WideString readonly
```

The response body returned as a string.

### HttpResponse.Charset

`Chilkat 11.7.0 · delphix · HttpResponse · Charset · property · read-only`

```pascal
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.

### HttpResponse.ContentLength

`Chilkat 11.7.0 · delphix · HttpResponse · ContentLength · property · read-only`

```pascal
property ContentLength: Integer readonly
```

The content length of the response, in bytes.

### HttpResponse.DateStr

`Chilkat 11.7.0 · delphix · HttpResponse · DateStr · property · read-only`

```pascal
property DateStr: WideString readonly
```

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

### HttpResponse.Domain

`Chilkat 11.7.0 · delphix · HttpResponse · Domain · property · read-only`

```pascal
property Domain: WideString readonly
```

The domain of the HTTP server that created this response.

### HttpResponse.FinalRedirectUrl

`Chilkat 11.7.0 · delphix · HttpResponse · FinalRedirectUrl · property · read-only · since 9.5.0.49`

```pascal
property FinalRedirectUrl: WideString readonly
```

Returns the redirect URL for 301/302 responses.

### HttpResponse.FullMime

`Chilkat 11.7.0 · delphix · HttpResponse · FullMime · property · read-only`

```pascal
property FullMime: WideString readonly
```

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

### HttpResponse.Header

`Chilkat 11.7.0 · delphix · HttpResponse · Header · property · read-only`

```pascal
property Header: WideString readonly
```

The full text of the response header.

### HttpResponse.NumCookies

`Chilkat 11.7.0 · delphix · HttpResponse · NumCookies · property · read-only`

```pascal
property NumCookies: Integer readonly
```

The number of cookies included in the response.

### HttpResponse.NumHeaderFields

`Chilkat 11.7.0 · delphix · HttpResponse · NumHeaderFields · property · read-only`

```pascal
property NumHeaderFields: Integer readonly
```

The number of response header fields.

### HttpResponse.StatusCode

`Chilkat 11.7.0 · delphix · HttpResponse · StatusCode · property · read-only`

```pascal
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.

### HttpResponse.StatusLine

`Chilkat 11.7.0 · delphix · HttpResponse · StatusLine · property · read-only`

```pascal
property StatusLine: WideString readonly
```

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

### HttpResponse.StatusText

`Chilkat 11.7.0 · delphix · HttpResponse · StatusText · property · read-only · since 9.5.0.49`

```pascal
property StatusText: WideString readonly
```

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`.

### HttpResponse.UncommonOptions

`Chilkat 11.7.0 · delphix · HttpResponse · UncommonOptions · property · read/write · since 9.5.0.89`

```pascal
property UncommonOptions: WideString
```

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.

## Methods

### HttpResponse.GetBodyBd

`Chilkat 11.7.0 · delphix · HttpResponse · GetBodyBd · method · since 9.5.0.64`

```pascal
function GetBodyBd(binData: IChilkatBinData): Integer;
```

Copies the response body to a BinData object.

Returns 1 for success, 0 for failure.

### HttpResponse.GetBodyJarr

`Chilkat 11.7.0 · delphix · HttpResponse · GetBodyJarr · method · since 9.5.0.89`

```pascal
function GetBodyJarr(jarr: IChilkatJsonArray): Integer;
```

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.

### HttpResponse.GetBodyJson

`Chilkat 11.7.0 · delphix · HttpResponse · GetBodyJson · method · since 9.5.0.89`

```pascal
function GetBodyJson(json: IChilkatJsonObject): Integer;
```

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.

### HttpResponse.GetBodySb

`Chilkat 11.7.0 · delphix · HttpResponse · GetBodySb · method · since 9.5.0.64`

```pascal
function GetBodySb(sb: IChilkatStringBuilder): Integer;
```

Copies the response body to a Chilkat StringBuilder object.

Returns 1 for success, 0 for failure.

### HttpResponse.GetBodyXml

`Chilkat 11.7.0 · delphix · HttpResponse · GetBodyXml · method · since 9.5.0.89`

```pascal
function GetBodyXml(xml: IChilkatXml): Integer;
```

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.

### HttpResponse.GetCookieDomain

`Chilkat 11.7.0 · delphix · HttpResponse · GetCookieDomain · method`

```pascal
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

### HttpResponse.GetCookieExpiresStr

`Chilkat 11.7.0 · delphix · HttpResponse · GetCookieExpiresStr · method`

```pascal
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

### HttpResponse.GetCookieName

`Chilkat 11.7.0 · delphix · HttpResponse · GetCookieName · method`

```pascal
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

### HttpResponse.GetCookiePath

`Chilkat 11.7.0 · delphix · HttpResponse · GetCookiePath · method`

```pascal
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

### HttpResponse.GetCookieValue

`Chilkat 11.7.0 · delphix · HttpResponse · GetCookieValue · method`

```pascal
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

### HttpResponse.GetHeaderField

`Chilkat 11.7.0 · delphix · HttpResponse · GetHeaderField · method`

```pascal
function GetHeaderField(fieldName: WideString): WideString;
```

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

Returns a zero-length WideString on failure

### HttpResponse.GetHeaderFieldAttr

`Chilkat 11.7.0 · delphix · HttpResponse · GetHeaderFieldAttr · method`

```pascal
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

### HttpResponse.GetHeaderName

`Chilkat 11.7.0 · delphix · HttpResponse · GetHeaderName · method`

```pascal
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

### HttpResponse.GetHeaderValue

`Chilkat 11.7.0 · delphix · HttpResponse · GetHeaderValue · method`

```pascal
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

### HttpResponse.LoadTaskResult

`Chilkat 11.7.0 · delphix · HttpResponse · LoadTaskResult · method · since 9.5.0.52`

```pascal
function LoadTaskResult(task: IChilkatTask): Integer;
```

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.

### HttpResponse.SaveBodyBinary

`Chilkat 11.7.0 · delphix · HttpResponse · SaveBodyBinary · method`

```pascal
function SaveBodyBinary(path: WideString): Integer;
```

Saves the body of the HTTP response to a file.

Returns 1 for success, 0 for failure.

### HttpResponse.SaveBodyText

`Chilkat 11.7.0 · delphix · HttpResponse · SaveBodyText · method`

```pascal
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.

### HttpResponse.UrlEncParamValue

`Chilkat 11.7.0 · delphix · HttpResponse · UrlEncParamValue · method`

```pascal
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

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/BinData.md), [`JsonArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/JsonArray.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/JsonObject.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/Task.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/Xml.md)