---
product: Chilkat
product_version: 11.7.0
language: delphidll
language_label: Delphi DLL
class: HttpRequest
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/dd_CkHttpRequestRef.html
---
# Chilkat HttpRequest — Delphi DLL — v11.7.0

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

## Purpose

**Build structured HTTP requests for use with Chilkat.Http.**

`Chilkat.HttpRequest` is a helper class for constructing HTTP requests that are sent by `Chilkat.Http`. It does not perform network communication on its own. Instead, it provides structured control over the request method, HTTP version, path, headers, query parameters, form parameters, content type, request body, multipart uploads, streamed file bodies, and diagnostic request generation.

**Request construction**

Build an HTTP request object with the method, path, version, headers, parameters, and body settings required by the target endpoint.

**Form parameters**

Add name/value parameters for form posts and API requests that expect structured form data.

**Custom headers**

Set request headers such as content type, accept headers, authorization headers, or application-specific metadata.

**Request bodies**

Provide body content for POST, PUT, PATCH, or other methods that send data to a server.

**Multipart and file uploads**

Construct multipart/form-data requests, attach file parts, or stream a file as the request body when the API requires upload content.

**Diagnostics**

Generate a textual representation of the request to inspect headers, paths, parameters, body structure, and upload formatting before sending.

**Common pattern:** Create a `HttpRequest`, set the HTTP method and path, add any headers, parameters, body data, or file parts, then pass the request object to the appropriate `Chilkat.Http` method for sending. Use `HttpRequest` for structured or multipart requests; use simpler `Http` methods directly when only a basic GET, POST, upload, or download is needed.

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

## Object creation, unlocking and error handling

**Create/Dispose**

```pascal
var
myObject: HCkHttpRequest;

begin
myObject := CkHttpRequest_Create();

// ...

CkHttpRequest_Dispose(myObject);
end;
```

`function CkHttpRequest_Create: HCkHttpRequest; stdcall;`

Creates an instance of the HCkHttpRequest object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

`procedure CkHttpRequest_Dispose(handle: HCkHttpRequest); stdcall;`

Objects created by calling CkHttpRequest_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

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

## 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` | `procedure CkHttpRequest_getDebugLogFilePath(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putDebugLogFilePath(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__debugLogFilePath(objHandle: HCkHttpRequest): PWideChar; stdcall;` | 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` | `procedure CkHttpRequest_getLastErrorHtml(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; function CkHttpRequest__lastErrorHtml(objHandle: HCkHttpRequest): PWideChar; stdcall;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `procedure CkHttpRequest_getLastErrorText(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; function CkHttpRequest__lastErrorText(objHandle: HCkHttpRequest): PWideChar; stdcall;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `procedure CkHttpRequest_getLastErrorXml(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; function CkHttpRequest__lastErrorXml(objHandle: HCkHttpRequest): PWideChar; stdcall;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `function CkHttpRequest_getLastMethodSuccess(objHandle: HCkHttpRequest): wordbool; stdcall; procedure CkHttpRequest_putLastMethodSuccess(objHandle: HCkHttpRequest; newPropVal: wordbool); stdcall;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `function CkHttpRequest_getVerboseLogging(objHandle: HCkHttpRequest): wordbool; stdcall; procedure CkHttpRequest_putVerboseLogging(objHandle: HCkHttpRequest; newPropVal: wordbool); stdcall;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `procedure CkHttpRequest_getVersion(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; function CkHttpRequest__version(objHandle: HCkHttpRequest): PWideChar; stdcall;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Boundary` | property, read/write | `procedure CkHttpRequest_getBoundary(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putBoundary(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__boundary(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `Charset` | property, read/write | `procedure CkHttpRequest_getCharset(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putCharset(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__charset(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `ContentType` | property, read/write | `procedure CkHttpRequest_getContentType(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putContentType(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__contentType(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `EntireHeader` | property, read/write | `procedure CkHttpRequest_getEntireHeader(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putEntireHeader(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__entireHeader(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `HttpVerb` | property, read/write | `procedure CkHttpRequest_getHttpVerb(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putHttpVerb(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__httpVerb(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `HttpVersion` | property, read/write | `procedure CkHttpRequest_getHttpVersion(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putHttpVersion(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__httpVersion(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `NumHeaderFields` | property, read-only | `function CkHttpRequest_getNumHeaderFields(objHandle: HCkHttpRequest): Integer; stdcall;` |
| `NumParams` | property, read-only | `function CkHttpRequest_getNumParams(objHandle: HCkHttpRequest): Integer; stdcall;` |
| `Path` | property, read/write | `procedure CkHttpRequest_getPath(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall; procedure CkHttpRequest_putPath(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall; function CkHttpRequest__path(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `SendCharset` | property, read/write | `function CkHttpRequest_getSendCharset(objHandle: HCkHttpRequest): wordbool; stdcall; procedure CkHttpRequest_putSendCharset(objHandle: HCkHttpRequest; newPropVal: wordbool); stdcall;` |
| `AddBdForUpload` | method | `function CkHttpRequest_AddBdForUpload(objHandle: HCkHttpRequest;     name: PWideChar;     remoteFilename: PWideChar;     byteData: HCkBinData;     contentType: PWideChar): wordbool; stdcall;` |
| `AddFileForUpload` | method | `function CkHttpRequest_AddFileForUpload(objHandle: HCkHttpRequest;     name: PWideChar;     filePath: PWideChar): wordbool; stdcall;` |
| `AddFileForUpload2` | method | `function CkHttpRequest_AddFileForUpload2(objHandle: HCkHttpRequest;     name: PWideChar;     filePath: PWideChar;     contentType: PWideChar): wordbool; stdcall;` |
| `AddHeader` | method | `procedure CkHttpRequest_AddHeader(objHandle: HCkHttpRequest;     name: PWideChar;     value: PWideChar) stdcall;` |
| `AddMwsSignature` | method | `function CkHttpRequest_AddMwsSignature(objHandle: HCkHttpRequest;     domain: PWideChar;     mwsSecretKey: PWideChar): wordbool; stdcall;` |
| `AddParam` | method | `procedure CkHttpRequest_AddParam(objHandle: HCkHttpRequest;     name: PWideChar;     value: PWideChar) stdcall;` |
| `AddStringForUpload` | method | `function CkHttpRequest_AddStringForUpload(objHandle: HCkHttpRequest;     name: PWideChar;     filename: PWideChar;     strData: PWideChar;     charset: PWideChar): wordbool; stdcall;` |
| `AddStringForUpload2` | method | `function CkHttpRequest_AddStringForUpload2(objHandle: HCkHttpRequest;     name: PWideChar;     filename: PWideChar;     strData: PWideChar;     charset: PWideChar;     contentType: PWideChar): wordbool; stdcall;` |
| `AddSubHeader` | method | `function CkHttpRequest_AddSubHeader(objHandle: HCkHttpRequest;     index: Integer;     name: PWideChar;     value: PWideChar): wordbool; stdcall;` |
| `GenerateRequestFile` | method | `function CkHttpRequest_GenerateRequestFile(objHandle: HCkHttpRequest;     path: PWideChar): wordbool; stdcall;` |
| `GenerateRequestText` | method | `function CkHttpRequest_GenerateRequestText(objHandle: HCkHttpRequest;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__generateRequestText(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `GetHeaderField` | method | `function CkHttpRequest_GetHeaderField(objHandle: HCkHttpRequest;     name: PWideChar;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__getHeaderField(objHandle: HCkHttpRequest;     name: PWideChar): PWideChar; stdcall;` |
| `GetHeaderName` | method | `function CkHttpRequest_GetHeaderName(objHandle: HCkHttpRequest;     index: Integer;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__getHeaderName(objHandle: HCkHttpRequest;     index: Integer): PWideChar; stdcall;` |
| `GetHeaderValue` | method | `function CkHttpRequest_GetHeaderValue(objHandle: HCkHttpRequest;     index: Integer;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__getHeaderValue(objHandle: HCkHttpRequest;     index: Integer): PWideChar; stdcall;` |
| `GetParam` | method | `function CkHttpRequest_GetParam(objHandle: HCkHttpRequest;     name: PWideChar;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__getParam(objHandle: HCkHttpRequest;     name: PWideChar): PWideChar; stdcall;` |
| `GetParamName` | method | `function CkHttpRequest_GetParamName(objHandle: HCkHttpRequest;     index: Integer;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__getParamName(objHandle: HCkHttpRequest;     index: Integer): PWideChar; stdcall;` |
| `GetParamValue` | method | `function CkHttpRequest_GetParamValue(objHandle: HCkHttpRequest;     index: Integer;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__getParamValue(objHandle: HCkHttpRequest;     index: Integer): PWideChar; stdcall;` |
| `GetUrlEncodedParams` | method | `function CkHttpRequest_GetUrlEncodedParams(objHandle: HCkHttpRequest;     outStr: HCkString): wordbool; stdcall; function CkHttpRequest__getUrlEncodedParams(objHandle: HCkHttpRequest): PWideChar; stdcall;` |
| `LoadBodyFromBd` | method | `function CkHttpRequest_LoadBodyFromBd(objHandle: HCkHttpRequest;     requestBody: HCkBinData): wordbool; stdcall;` |
| `LoadBodyFromFile` | method | `function CkHttpRequest_LoadBodyFromFile(objHandle: HCkHttpRequest;     filePath: PWideChar): wordbool; stdcall;` |
| `LoadBodyFromSb` | method | `function CkHttpRequest_LoadBodyFromSb(objHandle: HCkHttpRequest;     requestBody: HCkStringBuilder;     charset: PWideChar): wordbool; stdcall;` |
| `LoadBodyFromString` | method | `function CkHttpRequest_LoadBodyFromString(objHandle: HCkHttpRequest;     bodyStr: PWideChar;     charset: PWideChar): wordbool; stdcall;` |
| `RemoveAllParams` | method | `procedure CkHttpRequest_RemoveAllParams(objHandle: HCkHttpRequest) stdcall;` |
| `RemoveHeader` | method | `function CkHttpRequest_RemoveHeader(objHandle: HCkHttpRequest;     name: PWideChar): wordbool; stdcall;` |
| `RemoveParam` | method | `procedure CkHttpRequest_RemoveParam(objHandle: HCkHttpRequest;     name: PWideChar) stdcall;` |
| `SetFromUrl` | method | `procedure CkHttpRequest_SetFromUrl(objHandle: HCkHttpRequest;     url: PWideChar) stdcall;` |
| `StreamBodyFromFile` | method | `function CkHttpRequest_StreamBodyFromFile(objHandle: HCkHttpRequest;     filePath: PWideChar): wordbool; stdcall;` |
| `StreamChunkFromFile` | method | `function CkHttpRequest_StreamChunkFromFile(objHandle: HCkHttpRequest;     path: PWideChar;     offset: PWideChar;     numBytes: PWideChar): wordbool; stdcall;` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### HttpRequest.Boundary

`Chilkat 11.7.0 · delphidll · HttpRequest · Boundary · property · read/write · since 9.5.0.49`

```pascal
procedure CkHttpRequest_getBoundary(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall;
procedure CkHttpRequest_putBoundary(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall;
function CkHttpRequest__boundary(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

Sets an explicit boundary string to be used in multipart/form-data requests. If no Boundary is set, then a boundary string is automaticaly generated as needed during the sending of a request.

### HttpRequest.Charset

`Chilkat 11.7.0 · delphidll · HttpRequest · Charset · property · read/write`

```pascal
procedure CkHttpRequest_getCharset(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall;
procedure CkHttpRequest_putCharset(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall;
function CkHttpRequest__charset(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

**Full documentation for this property (same in every language):** [How Charset Matters with HTTP Query Parameters](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/how_charset_matters_with_http_query_params.md)

Controls the character encoding used in the URL encoding of query params. The default value of this propoerty is `utf-8`.

### HttpRequest.ContentType

`Chilkat 11.7.0 · delphidll · HttpRequest · ContentType · property · read/write`

```pascal
procedure CkHttpRequest_getContentType(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall;
procedure CkHttpRequest_putContentType(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall;
function CkHttpRequest__contentType(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

The ContentType property sets the `Content-Type` header field, and identifies the content-type of the HTTP request body. Common values are:

> ```
> application/x-www-form-urlencoded
> multipart/form-data
> application/json
> application/xml
> ```

If ContentType is set equal to the empty string, then no Content-Type header is included in the HTTP request.

### HttpRequest.EntireHeader

`Chilkat 11.7.0 · delphidll · HttpRequest · EntireHeader · property · read/write`

```pascal
procedure CkHttpRequest_getEntireHeader(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall;
procedure CkHttpRequest_putEntireHeader(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall;
function CkHttpRequest__entireHeader(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

Composes and returns the entire MIME header of the HTTP request.

### HttpRequest.HttpVerb

`Chilkat 11.7.0 · delphidll · HttpRequest · HttpVerb · property · read/write`

```pascal
procedure CkHttpRequest_getHttpVerb(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall;
procedure CkHttpRequest_putHttpVerb(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall;
function CkHttpRequest__httpVerb(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

The HttpVerb property should be set to the name of the HTTP method that appears on the `start line` of an HTTP request, such as GET, POST, PUT, DELETE, etc. It is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to anything, even custom verbs recognized by a custom server-side app.

### HttpRequest.HttpVersion

`Chilkat 11.7.0 · delphidll · HttpRequest · HttpVersion · property · read/write`

```pascal
procedure CkHttpRequest_getHttpVersion(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall;
procedure CkHttpRequest_putHttpVersion(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall;
function CkHttpRequest__httpVersion(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

The HTTP version in the request header. Defaults to `1.1`. Can only be set to `1.0` or `1.1`.

### HttpRequest.NumHeaderFields

`Chilkat 11.7.0 · delphidll · HttpRequest · NumHeaderFields · property · read-only`

```pascal
function CkHttpRequest_getNumHeaderFields(objHandle: HCkHttpRequest): Integer; stdcall;
```

Returns the number of request header fields.

### HttpRequest.NumParams

`Chilkat 11.7.0 · delphidll · HttpRequest · NumParams · property · read-only`

```pascal
function CkHttpRequest_getNumParams(objHandle: HCkHttpRequest): Integer; stdcall;
```

Returns the number of query parameters.

### HttpRequest.Path

`Chilkat 11.7.0 · delphidll · HttpRequest · Path · property · read/write`

```pascal
procedure CkHttpRequest_getPath(objHandle: HCkHttpRequest; outPropVal: HCkString); stdcall;
procedure CkHttpRequest_putPath(objHandle: HCkHttpRequest; newPropVal: PWideChar); stdcall;
function CkHttpRequest__path(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

The path of the resource requested. A path of `/` indicates the default document of a domain.

**Explaining the Parts of a URL**

```
http://example.com:8042/over/there?name=ferret#nose
\__/   \______________/\_________/ \________/ \__/
 |           |            |            |        |
scheme   domain+port     path        query   fragment
```

**This property should be set to the path part of the URL.** You may also include the query part in this property value. If the Content-Type of the request is NOT application/x-www-form-urlencoded, then you would definitely want to include query parameters in the path. If the Content-Type of the request IS application/x-www-form-urlencoded, the query parameters are passed in the body of the request. It is also possible to pass some query parameters via the path, and some in the body of a application/x-www-form-urlencoded request, but you shouldn't include the same parameter in both places. You would never need to include the fragment part. The fragment is nothing more than an instruction for a browser to automatically navigate to a particular location in the HTML page (assuming the request returns HTML, otherwise a fragment makes no sense).

### HttpRequest.SendCharset

`Chilkat 11.7.0 · delphidll · HttpRequest · SendCharset · property · read/write`

```pascal
function CkHttpRequest_getSendCharset(objHandle: HCkHttpRequest): wordbool; stdcall;
procedure CkHttpRequest_putSendCharset(objHandle: HCkHttpRequest; newPropVal: wordbool); stdcall;
```

Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request. The default value of this property is `False`.

## Methods

### HttpRequest.AddBdForUpload

`Chilkat 11.7.0 · delphidll · HttpRequest · AddBdForUpload · method · since 9.5.0.76`

```pascal
function CkHttpRequest_AddBdForUpload(objHandle: HCkHttpRequest;
    name: PWideChar;
    remoteFilename: PWideChar;
    byteData: HCkBinData;
    contentType: PWideChar): wordbool; stdcall;
```

Adds a file to an upload request where the contents of the file come from `byteData`.

`name` is an arbitrary name. (In HTML, it is the form field name of the input tag.)  
`remoteFilename` is the name of the file to be created on the HTTP server.  
`byteData` contains the bytes to be uploaded.  
`contentType` contains is the value of the Content-Type header. An empty string may be passed to allow Chilkat to automatically determine the Content-Type based on the filename extension.

Returns True for success, False for failure.

### HttpRequest.AddFileForUpload

`Chilkat 11.7.0 · delphidll · HttpRequest · AddFileForUpload · method`

```pascal
function CkHttpRequest_AddFileForUpload(objHandle: HCkHttpRequest;
    name: PWideChar;
    filePath: PWideChar): wordbool; stdcall;
```

Adds a file to an upload request. To create a file upload request, set the ContentType property = `multipart/form-data` and then call AddFileForUpload, AddBytesForUpload, or AddStringForUpload for each file to be uploaded. This method does not read the file into memory. When the upload occurs, the data is streamed directly from the file, thus allowing for very large files to be uploaded without consuming large amounts of memory.

`name` is an arbitrary name. (In HTML, it is the form field name of the input tag.)  
`filePath` is the path to an existing file in the local filesystem.

Returns True for success, False for failure.

### HttpRequest.AddFileForUpload2

`Chilkat 11.7.0 · delphidll · HttpRequest · AddFileForUpload2 · method`

```pascal
function CkHttpRequest_AddFileForUpload2(objHandle: HCkHttpRequest;
    name: PWideChar;
    filePath: PWideChar;
    contentType: PWideChar): wordbool; stdcall;
```

Same as AddFileForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the file extension.)

`name` is an arbitrary name. (In HTML, it is the form field name of the input tag.)  
`filePath` is the path to an existing file in the local filesystem.

Returns True for success, False for failure.

### HttpRequest.AddHeader

`Chilkat 11.7.0 · delphidll · HttpRequest · AddHeader · method`

```pascal
procedure CkHttpRequest_AddHeader(objHandle: HCkHttpRequest;
    name: PWideChar;
    value: PWideChar) stdcall;
```

Adds a request header to the HTTP request. If a header having the same field name is already present, this method replaces it.

**Note:** Never explicitly set the Content-Length header field. Chilkat will automatically compute the correct length and add the Content-Length header to all POST, PUT, or any other request where the Content-Length needs to be specified. (GET requests always have a 0 length body, and therefore never need a Content-Length header field.)

### HttpRequest.AddMwsSignature

`Chilkat 11.7.0 · delphidll · HttpRequest · AddMwsSignature · method · since 9.5.0.66`

```pascal
function CkHttpRequest_AddMwsSignature(objHandle: HCkHttpRequest;
    domain: PWideChar;
    mwsSecretKey: PWideChar): wordbool; stdcall;
```

Computes the Amazon MWS signature using the `mwsSecretKey` and adds the `Signature` parameter to the request. This method should be called for all Amazon Marketplace Web Service (Amazon MWS) HTTP requests. It should be called after all request parameters have been added.

**Important:** The Chilkat v9.5.0.75 release accidentally breaks Amazon MWS (not AWS) authentication. If you need MWS with 9.5.0.75, send email to support@chilkatsoft.com for a hotfix, or revert back to v9.5.0.73, or update to a version after 9.5.0.75.

The `domain` should be the domain of the request, such as one of the following:

- mws.amazonservices.com
- mws-eu.amazonservices.com
- mws.amazonservices.in
- mws.amazonservices.com.cn
- mws.amazonservices.jp

Note: This method automatically adds or replaces the existing Timestamp parameter to the current system date/time.

Returns True for success, False for failure.

### HttpRequest.AddParam

`Chilkat 11.7.0 · delphidll · HttpRequest · AddParam · method`

```pascal
procedure CkHttpRequest_AddParam(objHandle: HCkHttpRequest;
    name: PWideChar;
    value: PWideChar) stdcall;
```

Adds a request query parameter (name/value pair) to the HTTP request. The `name` and `value` strings passed to this method should not be URL encoded.

### HttpRequest.AddStringForUpload

`Chilkat 11.7.0 · delphidll · HttpRequest · AddStringForUpload · method`

```pascal
function CkHttpRequest_AddStringForUpload(objHandle: HCkHttpRequest;
    name: PWideChar;
    filename: PWideChar;
    strData: PWideChar;
    charset: PWideChar): wordbool; stdcall;
```

Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file.

Returns True for success, False for failure.

### HttpRequest.AddStringForUpload2

`Chilkat 11.7.0 · delphidll · HttpRequest · AddStringForUpload2 · method`

```pascal
function CkHttpRequest_AddStringForUpload2(objHandle: HCkHttpRequest;
    name: PWideChar;
    filename: PWideChar;
    strData: PWideChar;
    charset: PWideChar;
    contentType: PWideChar): wordbool; stdcall;
```

Same as AddStringForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the `filename`'s file extension.)

Returns True for success, False for failure.

### HttpRequest.AddSubHeader

`Chilkat 11.7.0 · delphidll · HttpRequest · AddSubHeader · method · since 9.5.0.55`

```pascal
function CkHttpRequest_AddSubHeader(objHandle: HCkHttpRequest;
    index: Integer;
    name: PWideChar;
    value: PWideChar): wordbool; stdcall;
```

Adds a request header to the Nth sub-header of the HTTP request. If a header having the same field name is already present, this method replaces it.

Returns True for success, False for failure.

### HttpRequest.GenerateRequestFile

`Chilkat 11.7.0 · delphidll · HttpRequest · GenerateRequestFile · method · since 9.5.0.64`

```pascal
function CkHttpRequest_GenerateRequestFile(objHandle: HCkHttpRequest;
    path: PWideChar): wordbool; stdcall;
```

The same as GenerateRequestText, except the generated request is written to the file specified by `path`.

Returns True for success, False for failure.

### HttpRequest.GenerateRequestText

`Chilkat 11.7.0 · delphidll · HttpRequest · GenerateRequestText · method`

```pascal
function CkHttpRequest_GenerateRequestText(objHandle: HCkHttpRequest;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__generateRequestText(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

Returns the request text that would be sent if Http.SynchronousRequest was called.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.GetHeaderField

`Chilkat 11.7.0 · delphidll · HttpRequest · GetHeaderField · method`

```pascal
function CkHttpRequest_GetHeaderField(objHandle: HCkHttpRequest;
    name: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__getHeaderField(objHandle: HCkHttpRequest;
    name: PWideChar): PWideChar; stdcall;
```

Returns the value of a request header field.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.GetHeaderName

`Chilkat 11.7.0 · delphidll · HttpRequest · GetHeaderName · method`

```pascal
function CkHttpRequest_GetHeaderName(objHandle: HCkHttpRequest;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__getHeaderName(objHandle: HCkHttpRequest;
    index: Integer): PWideChar; stdcall;
```

Returns the Nth request header field name. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.GetHeaderValue

`Chilkat 11.7.0 · delphidll · HttpRequest · GetHeaderValue · method`

```pascal
function CkHttpRequest_GetHeaderValue(objHandle: HCkHttpRequest;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__getHeaderValue(objHandle: HCkHttpRequest;
    index: Integer): PWideChar; stdcall;
```

Returns the Nth request header field value. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.GetParam

`Chilkat 11.7.0 · delphidll · HttpRequest · GetParam · method`

```pascal
function CkHttpRequest_GetParam(objHandle: HCkHttpRequest;
    name: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__getParam(objHandle: HCkHttpRequest;
    name: PWideChar): PWideChar; stdcall;
```

Returns a request query parameter value by name.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.GetParamName

`Chilkat 11.7.0 · delphidll · HttpRequest · GetParamName · method`

```pascal
function CkHttpRequest_GetParamName(objHandle: HCkHttpRequest;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__getParamName(objHandle: HCkHttpRequest;
    index: Integer): PWideChar; stdcall;
```

Returns the Nth request query parameter field name. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.GetParamValue

`Chilkat 11.7.0 · delphidll · HttpRequest · GetParamValue · method`

```pascal
function CkHttpRequest_GetParamValue(objHandle: HCkHttpRequest;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__getParamValue(objHandle: HCkHttpRequest;
    index: Integer): PWideChar; stdcall;
```

Returns the Nth request query parameter field value. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.GetUrlEncodedParams

`Chilkat 11.7.0 · delphidll · HttpRequest · GetUrlEncodedParams · method`

```pascal
function CkHttpRequest_GetUrlEncodedParams(objHandle: HCkHttpRequest;
    outStr: HCkString): wordbool; stdcall;
function CkHttpRequest__getUrlEncodedParams(objHandle: HCkHttpRequest): PWideChar; stdcall;
```

Returns the request parameters in URL encoded form (i.e. in the exact form that would be sent if the ContentType property was application/x-www-form-urlencoded). For example, if a request has two params: param1=`abc 123` and param2=`abc-123`, then GetUrlEncodedParams would return `abc+123&param2=abc%2D123`

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

### HttpRequest.LoadBodyFromBd

`Chilkat 11.7.0 · delphidll · HttpRequest · LoadBodyFromBd · method · since 9.5.0.67`

```pascal
function CkHttpRequest_LoadBodyFromBd(objHandle: HCkHttpRequest;
    requestBody: HCkBinData): wordbool; stdcall;
```

Uses the contents of the `requestBody` as the HTTP request body.

Returns True for success, False for failure.

### HttpRequest.LoadBodyFromFile

`Chilkat 11.7.0 · delphidll · HttpRequest · LoadBodyFromFile · method`

```pascal
function CkHttpRequest_LoadBodyFromFile(objHandle: HCkHttpRequest;
    filePath: PWideChar): wordbool; stdcall;
```

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of `filePath`.  
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

Returns True for success, False for failure.

### HttpRequest.LoadBodyFromSb

`Chilkat 11.7.0 · delphidll · HttpRequest · LoadBodyFromSb · method · since 9.5.0.67`

```pascal
function CkHttpRequest_LoadBodyFromSb(objHandle: HCkHttpRequest;
    requestBody: HCkStringBuilder;
    charset: PWideChar): wordbool; stdcall;
```

Uses the contents of the `requestBody` as the HTTP request body. The `charset` indicates the binary representation of the string, such as `utf-8`, `utf-16`, `iso-8859-*`, `windows-125*`, etc. Any of the character encodings supported at the link below are valid.

Returns True for success, False for failure.

See also:

- [Chilkat Supported Character Encodings](http://cknotes.com/chilkat-charsets-character-encodings-supported/)

### HttpRequest.LoadBodyFromString

`Chilkat 11.7.0 · delphidll · HttpRequest · LoadBodyFromString · method`

```pascal
function CkHttpRequest_LoadBodyFromString(objHandle: HCkHttpRequest;
    bodyStr: PWideChar;
    charset: PWideChar): wordbool; stdcall;
```

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of `bodyStr`.  
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

`charset` indicates the charset, such as `utf-8` or `iso-8859-1`, to be used. The HTTP body will contain the `bodyStr` converted to this character encoding.

Returns True for success, False for failure.

### HttpRequest.RemoveAllParams

`Chilkat 11.7.0 · delphidll · HttpRequest · RemoveAllParams · method`

```pascal
procedure CkHttpRequest_RemoveAllParams(objHandle: HCkHttpRequest) stdcall;
```

Removes all request parameters.

### HttpRequest.RemoveHeader

`Chilkat 11.7.0 · delphidll · HttpRequest · RemoveHeader · method`

```pascal
function CkHttpRequest_RemoveHeader(objHandle: HCkHttpRequest;
    name: PWideChar): wordbool; stdcall;
```

Removes all occurrences of a HTTP request header field. Always returns `True`.

Returns True for success, False for failure.

### HttpRequest.RemoveParam

`Chilkat 11.7.0 · delphidll · HttpRequest · RemoveParam · method`

```pascal
procedure CkHttpRequest_RemoveParam(objHandle: HCkHttpRequest;
    name: PWideChar) stdcall;
```

Removes a single HTTP request parameter by name.

### HttpRequest.SetFromUrl

`Chilkat 11.7.0 · delphidll · HttpRequest · SetFromUrl · method`

```pascal
procedure CkHttpRequest_SetFromUrl(objHandle: HCkHttpRequest;
    url: PWideChar) stdcall;
```

Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).

### HttpRequest.StreamBodyFromFile

`Chilkat 11.7.0 · delphidll · HttpRequest · StreamBodyFromFile · method`

```pascal
function CkHttpRequest_StreamBodyFromFile(objHandle: HCkHttpRequest;
    filePath: PWideChar): wordbool; stdcall;
```

Useful for sending HTTP requests where the body is a very large file. For example, to send an XML HttpRequest containing a very large XML document, one would set the HttpVerb = `POST`, the ContentType = `text/xml`, and then call StreamBodyFromFile to indicate that the XML body of the request is to be streamed directly from a file. When the HTTP request is actually sent, the body is streamed directly from the file, and thus the file never needs to be loaded in its entirety in memory.

Returns True for success, False for failure.

### HttpRequest.StreamChunkFromFile

`Chilkat 11.7.0 · delphidll · HttpRequest · StreamChunkFromFile · method · since 9.5.0.55`

```pascal
function CkHttpRequest_StreamChunkFromFile(objHandle: HCkHttpRequest;
    path: PWideChar;
    offset: PWideChar;
    numBytes: PWideChar): wordbool; stdcall;
```

This method is the same as StreamBodyFromFile, but allows for an offset and number of bytes to be specified. The `offset` and `numBytes` are integers passed as strings.

Returns True for success, False for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `AddBytesForUpload` | method | before 11.6.1 | — |
| `AddBytesForUpload2` | method | before 11.6.1 | — |
| `LoadBodyFromBytes` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/classes/StringBuilder.md)

