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

> Chilkat 11.7.0 · language=tcl · 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/tcl/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**

```tcl
# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkHttpResponse]
```

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

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 # ckStr is a CkString CkHttpResponse_get_DebugLogFilePath $this $ckStr set strVal [CkHttpResponse_get_debugLogFilePath $this] CkHttpResponse_put_DebugLogFilePath $this $strVal` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `string # ckStr is a CkString CkHttpResponse_get_LastErrorHtml $this $ckStr set strVal [CkHttpResponse_get_lastErrorHtml $this]` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string # ckStr is a CkString CkHttpResponse_get_LastErrorText $this $ckStr set strVal [CkHttpResponse_get_lastErrorText $this]` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string # ckStr is a CkString CkHttpResponse_get_LastErrorXml $this $ckStr set strVal [CkHttpResponse_get_lastErrorXml $this]` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean 1/0 set boolVal [CkHttpResponse_get_LastMethodSuccess $this] CkHttpResponse_put_LastMethodSuccess $this $boolVal` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `boolean 1/0 set boolVal [CkHttpResponse_get_Utf8 $this] CkHttpResponse_put_Utf8 $this $boolVal` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `boolean 1/0 set boolVal [CkHttpResponse_get_VerboseLogging $this] CkHttpResponse_put_VerboseLogging $this $boolVal` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string # ckStr is a CkString CkHttpResponse_get_Version $this $ckStr set strVal [CkHttpResponse_get_version $this]` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BodyQP` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_BodyQP $this $ckStr set strVal [CkHttpResponse_get_bodyQP $this]` |
| `BodyStr` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_BodyStr $this $ckStr set strVal [CkHttpResponse_get_bodyStr $this]` |
| `Charset` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_Charset $this $ckStr set strVal [CkHttpResponse_get_charset $this]` |
| `ContentLength` | property, read-only | `unsigned integer set intVal [CkHttpResponse_get_ContentLength $this]` |
| `ContentLength64` | property, read-only | `(64-bit integer) set int64Val [CkHttpResponse_get_ContentLength64 $this]` |
| `DateStr` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_DateStr $this $ckStr set strVal [CkHttpResponse_get_dateStr $this]` |
| `Domain` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_Domain $this $ckStr set strVal [CkHttpResponse_get_domain $this]` |
| `FinalRedirectUrl` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_FinalRedirectUrl $this $ckStr set strVal [CkHttpResponse_get_finalRedirectUrl $this]` |
| `FullMime` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_FullMime $this $ckStr set strVal [CkHttpResponse_get_fullMime $this]` |
| `Header` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_Header $this $ckStr set strVal [CkHttpResponse_get_header $this]` |
| `NumCookies` | property, read-only | `integer set intVal [CkHttpResponse_get_NumCookies $this]` |
| `NumHeaderFields` | property, read-only | `integer set intVal [CkHttpResponse_get_NumHeaderFields $this]` |
| `StatusCode` | property, read-only | `integer set intVal [CkHttpResponse_get_StatusCode $this]` |
| `StatusLine` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_StatusLine $this $ckStr set strVal [CkHttpResponse_get_statusLine $this]` |
| `StatusText` | property, read-only | `string # ckStr is a CkString CkHttpResponse_get_StatusText $this $ckStr set strVal [CkHttpResponse_get_statusText $this]` |
| `UncommonOptions` | property, read/write | `string # ckStr is a CkString CkHttpResponse_get_UncommonOptions $this $ckStr set strVal [CkHttpResponse_get_uncommonOptions $this] CkHttpResponse_put_UncommonOptions $this $strVal` |
| `GetBodyBd` | method | `# binData is a CkBinData set status [CkHttpResponse_GetBodyBd $this $binData]` |
| `GetBodyJarr` | method | `# jarr is a CkJsonArray set status [CkHttpResponse_GetBodyJarr $this $jarr]` |
| `GetBodyJson` | method | `# json is a CkJsonObject set status [CkHttpResponse_GetBodyJson $this $json]` |
| `GetBodySb` | method | `# sb is a CkStringBuilder set status [CkHttpResponse_GetBodySb $this $sb]` |
| `GetBodyXml` | method | `# xml is a CkXml set status [CkHttpResponse_GetBodyXml $this $xml]` |
| `GetCookieDomain` | method | `# index is an integer # outStr is a CkString (output) set status [CkHttpResponse_GetCookieDomain $this $index $outStr] set retStr [CkHttpResponse_getCookieDomain $this $index]` |
| `GetCookieExpiresStr` | method | `# index is an integer # outStr is a CkString (output) set status [CkHttpResponse_GetCookieExpiresStr $this $index $outStr] set retStr [CkHttpResponse_getCookieExpiresStr $this $index]` |
| `GetCookieName` | method | `# index is an integer # outStr is a CkString (output) set status [CkHttpResponse_GetCookieName $this $index $outStr] set retStr [CkHttpResponse_getCookieName $this $index]` |
| `GetCookiePath` | method | `# index is an integer # outStr is a CkString (output) set status [CkHttpResponse_GetCookiePath $this $index $outStr] set retStr [CkHttpResponse_getCookiePath $this $index]` |
| `GetCookieValue` | method | `# index is an integer # outStr is a CkString (output) set status [CkHttpResponse_GetCookieValue $this $index $outStr] set retStr [CkHttpResponse_getCookieValue $this $index]` |
| `GetHeaderField` | method | `# fieldName is a string # outStr is a CkString (output) set status [CkHttpResponse_GetHeaderField $this $fieldName $outStr] set retStr [CkHttpResponse_getHeaderField $this $fieldName]` |
| `GetHeaderFieldAttr` | method | `# fieldName is a string # attrName is a string # outStr is a CkString (output) set status [CkHttpResponse_GetHeaderFieldAttr $this $fieldName $attrName $outStr] set retStr [CkHttpResponse_getHeaderFieldAttr $this $fieldName $attrName]` |
| `GetHeaderName` | method | `# index is an integer # outStr is a CkString (output) set status [CkHttpResponse_GetHeaderName $this $index $outStr] set retStr [CkHttpResponse_getHeaderName $this $index]` |
| `GetHeaderValue` | method | `# index is an integer # outStr is a CkString (output) set status [CkHttpResponse_GetHeaderValue $this $index $outStr] set retStr [CkHttpResponse_getHeaderValue $this $index]` |
| `LoadTaskResult` | method | `# task is a CkTask set status [CkHttpResponse_LoadTaskResult $this $task]` |
| `SaveBodyBinary` | method | `# path is a string set status [CkHttpResponse_SaveBodyBinary $this $path]` |
| `SaveBodyText` | method | `# bCrlf is a boolean # path is a string set status [CkHttpResponse_SaveBodyText $this $bCrlf $path]` |
| `UrlEncParamValue` | method | `# encodedParamString is a string # paramName is a string # outStr is a CkString (output) set status [CkHttpResponse_UrlEncParamValue $this $encodedParamString $paramName $outStr] set retStr [CkHttpResponse_urlEncParamValue $this $encodedParamString $paramName]` |

## Properties

### HttpResponse.BodyQP

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_BodyQP $this $ckStr

set strVal [CkHttpResponse_get_bodyQP $this]
```

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

### HttpResponse.BodyStr

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_BodyStr $this $ckStr

set strVal [CkHttpResponse_get_bodyStr $this]
```

The response body returned as a string.

### HttpResponse.Charset

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_Charset $this $ckStr

set strVal [CkHttpResponse_get_charset $this]
```

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

```tcl
unsigned integer
set intVal [CkHttpResponse_get_ContentLength $this]
```

The content length of the response, in bytes.

### HttpResponse.ContentLength64

`Chilkat 11.7.0 · tcl · HttpResponse · ContentLength64 · property · read-only`

```tcl
(64-bit integer)
set int64Val [CkHttpResponse_get_ContentLength64 $this]
```

The content length of the response, in number of bytes, returned as a 64-bit integer.

### HttpResponse.DateStr

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_DateStr $this $ckStr

set strVal [CkHttpResponse_get_dateStr $this]
```

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

### HttpResponse.Domain

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_Domain $this $ckStr

set strVal [CkHttpResponse_get_domain $this]
```

The domain of the HTTP server that created this response.

### HttpResponse.FinalRedirectUrl

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_FinalRedirectUrl $this $ckStr

set strVal [CkHttpResponse_get_finalRedirectUrl $this]
```

Returns the redirect URL for 301/302 responses.

### HttpResponse.FullMime

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_FullMime $this $ckStr

set strVal [CkHttpResponse_get_fullMime $this]
```

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

### HttpResponse.Header

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_Header $this $ckStr

set strVal [CkHttpResponse_get_header $this]
```

The full text of the response header.

### HttpResponse.NumCookies

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

```tcl
integer
set intVal [CkHttpResponse_get_NumCookies $this]
```

The number of cookies included in the response.

### HttpResponse.NumHeaderFields

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

```tcl
integer
set intVal [CkHttpResponse_get_NumHeaderFields $this]
```

The number of response header fields.

### HttpResponse.StatusCode

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

```tcl
integer
set intVal [CkHttpResponse_get_StatusCode $this]
```

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 · tcl · HttpResponse · StatusLine · property · read-only`

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_StatusLine $this $ckStr

set strVal [CkHttpResponse_get_statusLine $this]
```

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

### HttpResponse.StatusText

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_StatusText $this $ckStr

set strVal [CkHttpResponse_get_statusText $this]
```

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

```tcl
string
# ckStr is a CkString

CkHttpResponse_get_UncommonOptions $this $ckStr

set strVal [CkHttpResponse_get_uncommonOptions $this]

CkHttpResponse_put_UncommonOptions $this $strVal
```

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

```tcl
# binData is a CkBinData

set status [CkHttpResponse_GetBodyBd $this $binData]
```

Copies the response body to a BinData object.

Returns 1 for success, 0 for failure.

### HttpResponse.GetBodyJarr

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

```tcl
# jarr is a CkJsonArray

set status [CkHttpResponse_GetBodyJarr $this $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 · tcl · HttpResponse · GetBodyJson · method · since 9.5.0.89`

```tcl
# json is a CkJsonObject

set status [CkHttpResponse_GetBodyJson $this $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 · tcl · HttpResponse · GetBodySb · method · since 9.5.0.64`

```tcl
# sb is a CkStringBuilder

set status [CkHttpResponse_GetBodySb $this $sb]
```

Copies the response body to a Chilkat StringBuilder object.

Returns 1 for success, 0 for failure.

### HttpResponse.GetBodyXml

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

```tcl
# xml is a CkXml

set status [CkHttpResponse_GetBodyXml $this $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 · tcl · HttpResponse · GetCookieDomain · method`

```tcl
# index is an integer

# outStr is a CkString (output)

set status [CkHttpResponse_GetCookieDomain $this $index $outStr]

set retStr [CkHttpResponse_getCookieDomain $this $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 1 for success, 0 for failure.

### HttpResponse.GetCookieExpiresStr

`Chilkat 11.7.0 · tcl · HttpResponse · GetCookieExpiresStr · method`

```tcl
# index is an integer

# outStr is a CkString (output)

set status [CkHttpResponse_GetCookieExpiresStr $this $index $outStr]

set retStr [CkHttpResponse_getCookieExpiresStr $this $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 1 for success, 0 for failure.

### HttpResponse.GetCookieName

`Chilkat 11.7.0 · tcl · HttpResponse · GetCookieName · method`

```tcl
# index is an integer

# outStr is a CkString (output)

set status [CkHttpResponse_GetCookieName $this $index $outStr]

set retStr [CkHttpResponse_getCookieName $this $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 1 for success, 0 for failure.

### HttpResponse.GetCookiePath

`Chilkat 11.7.0 · tcl · HttpResponse · GetCookiePath · method`

```tcl
# index is an integer

# outStr is a CkString (output)

set status [CkHttpResponse_GetCookiePath $this $index $outStr]

set retStr [CkHttpResponse_getCookiePath $this $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 1 for success, 0 for failure.

### HttpResponse.GetCookieValue

`Chilkat 11.7.0 · tcl · HttpResponse · GetCookieValue · method`

```tcl
# index is an integer

# outStr is a CkString (output)

set status [CkHttpResponse_GetCookieValue $this $index $outStr]

set retStr [CkHttpResponse_getCookieValue $this $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 1 for success, 0 for failure.

### HttpResponse.GetHeaderField

`Chilkat 11.7.0 · tcl · HttpResponse · GetHeaderField · method`

```tcl
# fieldName is a string

# outStr is a CkString (output)

set status [CkHttpResponse_GetHeaderField $this $fieldName $outStr]

set retStr [CkHttpResponse_getHeaderField $this $fieldName]
```

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

Returns 1 for success, 0 for failure.

### HttpResponse.GetHeaderFieldAttr

`Chilkat 11.7.0 · tcl · HttpResponse · GetHeaderFieldAttr · method`

```tcl
# fieldName is a string

# attrName is a string

# outStr is a CkString (output)

set status [CkHttpResponse_GetHeaderFieldAttr $this $fieldName  $attrName $outStr]

set retStr [CkHttpResponse_getHeaderFieldAttr $this $fieldName $attrName]
```

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

Returns 1 for success, 0 for failure.

### HttpResponse.GetHeaderName

`Chilkat 11.7.0 · tcl · HttpResponse · GetHeaderName · method`

```tcl
# index is an integer

# outStr is a CkString (output)

set status [CkHttpResponse_GetHeaderName $this $index $outStr]

set retStr [CkHttpResponse_getHeaderName $this $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 1 for success, 0 for failure.

### HttpResponse.GetHeaderValue

`Chilkat 11.7.0 · tcl · HttpResponse · GetHeaderValue · method`

```tcl
# index is an integer

# outStr is a CkString (output)

set status [CkHttpResponse_GetHeaderValue $this $index $outStr]

set retStr [CkHttpResponse_getHeaderValue $this $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 1 for success, 0 for failure.

### HttpResponse.LoadTaskResult

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

```tcl
# task is a CkTask

set status [CkHttpResponse_LoadTaskResult $this $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 · tcl · HttpResponse · SaveBodyBinary · method`

```tcl
# path is a string

set status [CkHttpResponse_SaveBodyBinary $this $path]
```

Saves the body of the HTTP response to a file.

Returns 1 for success, 0 for failure.

### HttpResponse.SaveBodyText

`Chilkat 11.7.0 · tcl · HttpResponse · SaveBodyText · method`

```tcl
# bCrlf is a boolean

# path is a string

set status [CkHttpResponse_SaveBodyText $this $bCrlf  $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 · tcl · HttpResponse · UrlEncParamValue · method`

```tcl
# encodedParamString is a string

# paramName is a string

# outStr is a CkString (output)

set status [CkHttpResponse_UrlEncParamValue $this $encodedParamString  $paramName $outStr]

set retStr [CkHttpResponse_urlEncParamValue $this $encodedParamString $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 1 for success, 0 for failure.

## Related classes

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