---
product: Chilkat
product_version: 11.7.0
language: powerbuilder
language_label: PowerBuilder
class: HttpResponse
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/powerbuilder_HttpResponseRef.html
---
# Chilkat HttpResponse — PowerBuilder — v11.7.0

> Chilkat 11.7.0 · language=powerbuilder · class=HttpResponse
> 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/powerbuilder/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**

```powerbuilder
oleobject loo_HttpResponse
integer li_rc

loo_HttpResponse = create oleobject
li_rc = loo_HttpResponse.ConnectToNewObject("Chilkat.HttpResponse")
if li_rc < 0 then
    destroy loo_HttpResponse
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_HttpResponse ...

destroy loo_HttpResponse
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.HttpResponse.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

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

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` | `string DebugLogFilePath` | 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` | `blob LastBinaryResult (read-only)` | 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` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | 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` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Body` | property, read-only | `blob Body (read-only)` |
| `BodyQP` | property, read-only | `string BodyQP (read-only)` |
| `BodyStr` | property, read-only | `string BodyStr (read-only)` |
| `Charset` | property, read-only | `string Charset (read-only)` |
| `ContentLength` | property, read-only | `long ContentLength (read-only)` |
| `DateStr` | property, read-only | `string DateStr (read-only)` |
| `Domain` | property, read-only | `string Domain (read-only)` |
| `FinalRedirectUrl` | property, read-only | `string FinalRedirectUrl (read-only)` |
| `FullMime` | property, read-only | `string FullMime (read-only)` |
| `Header` | property, read-only | `string Header (read-only)` |
| `NumCookies` | property, read-only | `long NumCookies (read-only)` |
| `NumHeaderFields` | property, read-only | `long NumHeaderFields (read-only)` |
| `StatusCode` | property, read-only | `long StatusCode (read-only)` |
| `StatusLine` | property, read-only | `string StatusLine (read-only)` |
| `StatusText` | property, read-only | `string StatusText (read-only)` |
| `UncommonOptions` | property, read/write | `string UncommonOptions` |
| `GetBodyBd` | method | `long GetBodyBd(ChilkatBinData binData)` |
| `GetBodyJarr` | method | `long GetBodyJarr(ChilkatJsonArray jarr)` |
| `GetBodyJson` | method | `long GetBodyJson(ChilkatJsonObject json)` |
| `GetBodySb` | method | `long GetBodySb(ChilkatStringBuilder sb)` |
| `GetBodyXml` | method | `long GetBodyXml(ChilkatXml xml)` |
| `GetCookieDomain` | method | `string GetCookieDomain(long index)` |
| `GetCookieExpiresStr` | method | `string GetCookieExpiresStr(long index)` |
| `GetCookieName` | method | `string GetCookieName(long index)` |
| `GetCookiePath` | method | `string GetCookiePath(long index)` |
| `GetCookieValue` | method | `string GetCookieValue(long index)` |
| `GetHeaderField` | method | `string GetHeaderField(string fieldName)` |
| `GetHeaderFieldAttr` | method | `string GetHeaderFieldAttr(string fieldName, string attrName)` |
| `GetHeaderName` | method | `string GetHeaderName(long index)` |
| `GetHeaderValue` | method | `string GetHeaderValue(long index)` |
| `LoadTaskResult` | method | `long LoadTaskResult(ChilkatTask task)` |
| `SaveBodyBinary` | method | `long SaveBodyBinary(string path)` |
| `SaveBodyText` | method | `long SaveBodyText(long bCrlf, string path)` |
| `UrlEncParamValue` | method | `string UrlEncParamValue(string encodedParamString, string paramName)` |

## Properties

### HttpResponse.Body

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

```powerbuilder
blob Body (read-only)
```

The response body returned as a byte array.

### HttpResponse.BodyQP

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

```powerbuilder
string BodyQP (read-only)
```

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

### HttpResponse.BodyStr

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

```powerbuilder
string BodyStr (read-only)
```

The response body returned as a string.

### HttpResponse.Charset

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

```powerbuilder
string Charset (read-only)
```

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 · powerbuilder · HttpResponse · ContentLength · property · read-only`

```powerbuilder
long ContentLength (read-only)
```

The content length of the response, in bytes.

### HttpResponse.DateStr

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

```powerbuilder
string DateStr (read-only)
```

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

### HttpResponse.Domain

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

```powerbuilder
string Domain (read-only)
```

The domain of the HTTP server that created this response.

### HttpResponse.FinalRedirectUrl

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

```powerbuilder
string FinalRedirectUrl (read-only)
```

Returns the redirect URL for 301/302 responses.

### HttpResponse.FullMime

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

```powerbuilder
string FullMime (read-only)
```

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

### HttpResponse.Header

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

```powerbuilder
string Header (read-only)
```

The full text of the response header.

### HttpResponse.NumCookies

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

```powerbuilder
long NumCookies (read-only)
```

The number of cookies included in the response.

### HttpResponse.NumHeaderFields

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

```powerbuilder
long NumHeaderFields (read-only)
```

The number of response header fields.

### HttpResponse.StatusCode

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

```powerbuilder
long StatusCode (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.

### HttpResponse.StatusLine

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

```powerbuilder
string StatusLine (read-only)
```

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

### HttpResponse.StatusText

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

```powerbuilder
string StatusText (read-only)
```

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 · powerbuilder · HttpResponse · UncommonOptions · property · read/write · since 9.5.0.89`

```powerbuilder
string UncommonOptions
```

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 · powerbuilder · HttpResponse · GetBodyBd · method · since 9.5.0.64`

```powerbuilder
long GetBodyBd(ChilkatBinData binData)
```

Copies the response body to a BinData object.

Returns 1 for success, 0 for failure.

### HttpResponse.GetBodyJarr

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

```powerbuilder
long GetBodyJarr(ChilkatJsonArray jarr)
```

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 · powerbuilder · HttpResponse · GetBodyJson · method · since 9.5.0.89`

```powerbuilder
long GetBodyJson(ChilkatJsonObject json)
```

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 · powerbuilder · HttpResponse · GetBodySb · method · since 9.5.0.64`

```powerbuilder
long GetBodySb(ChilkatStringBuilder sb)
```

Copies the response body to a Chilkat StringBuilder object.

Returns 1 for success, 0 for failure.

### HttpResponse.GetBodyXml

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

```powerbuilder
long GetBodyXml(ChilkatXml xml)
```

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 · powerbuilder · HttpResponse · GetCookieDomain · method`

```powerbuilder
string GetCookieDomain(long index)
```

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

### HttpResponse.GetCookieExpiresStr

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetCookieExpiresStr · method`

```powerbuilder
string GetCookieExpiresStr(long index)
```

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

### HttpResponse.GetCookieName

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetCookieName · method`

```powerbuilder
string GetCookieName(long index)
```

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

### HttpResponse.GetCookiePath

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetCookiePath · method`

```powerbuilder
string GetCookiePath(long index)
```

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

### HttpResponse.GetCookieValue

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetCookieValue · method`

```powerbuilder
string GetCookieValue(long index)
```

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

### HttpResponse.GetHeaderField

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetHeaderField · method`

```powerbuilder
string GetHeaderField(string fieldName)
```

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

Returns `null` on failure

### HttpResponse.GetHeaderFieldAttr

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetHeaderFieldAttr · method`

```powerbuilder
string GetHeaderFieldAttr(string fieldName, string attrName)
```

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

Returns `null` on failure

### HttpResponse.GetHeaderName

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetHeaderName · method`

```powerbuilder
string GetHeaderName(long index)
```

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

### HttpResponse.GetHeaderValue

`Chilkat 11.7.0 · powerbuilder · HttpResponse · GetHeaderValue · method`

```powerbuilder
string GetHeaderValue(long index)
```

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

### HttpResponse.LoadTaskResult

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

```powerbuilder
long LoadTaskResult(ChilkatTask task)
```

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 · powerbuilder · HttpResponse · SaveBodyBinary · method`

```powerbuilder
long SaveBodyBinary(string path)
```

Saves the body of the HTTP response to a file.

Returns 1 for success, 0 for failure.

### HttpResponse.SaveBodyText

`Chilkat 11.7.0 · powerbuilder · HttpResponse · SaveBodyText · method`

```powerbuilder
long SaveBodyText(long bCrlf, string path)
```

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 · powerbuilder · HttpResponse · UrlEncParamValue · method`

```powerbuilder
string UrlEncParamValue(string encodedParamString, string paramName)
```

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

## Related classes

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

