---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: HttpRequest
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_HttpRequestRef.html
---
# Chilkat HttpRequest — SQL Server — v11.7.0

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

**Object Creation**

```sql
DECLARE @hr int
DECLARE @httpRequest int
EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @httpRequest OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @httpRequest ...

EXEC @hr = sp_OADestroy @httpRequest
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.HttpRequest.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @httpRequest, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Boundary` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'Boundary', @sValue OUT EXEC sp_OASetProperty @httpRequest, 'Boundary', @sValue` |
| `Charset` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'Charset', @sValue OUT EXEC sp_OASetProperty @httpRequest, 'Charset', @sValue` |
| `ContentType` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'ContentType', @sValue OUT EXEC sp_OASetProperty @httpRequest, 'ContentType', @sValue` |
| `EntireHeader` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'EntireHeader', @sValue OUT EXEC sp_OASetProperty @httpRequest, 'EntireHeader', @sValue` |
| `HttpVerb` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'HttpVerb', @sValue OUT EXEC sp_OASetProperty @httpRequest, 'HttpVerb', @sValue` |
| `HttpVersion` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'HttpVersion', @sValue OUT EXEC sp_OASetProperty @httpRequest, 'HttpVersion', @sValue` |
| `NumHeaderFields` | property, read-only | `EXEC sp_OAGetProperty @httpRequest, 'NumHeaderFields', @iValue OUT` |
| `NumParams` | property, read-only | `EXEC sp_OAGetProperty @httpRequest, 'NumParams', @iValue OUT` |
| `Path` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'Path', @sValue OUT EXEC sp_OASetProperty @httpRequest, 'Path', @sValue` |
| `SendCharset` | property, read/write | `EXEC sp_OAGetProperty @httpRequest, 'SendCharset', @iValue OUT EXEC sp_OASetProperty @httpRequest, 'SendCharset', @iValue` |
| `AddBdForUpload` | method | `EXEC sp_OAMethod @httpRequest, 'AddBdForUpload', @success OUT, @name, @remoteFilename, @byteData, @contentType` |
| `AddFileForUpload` | method | `EXEC sp_OAMethod @httpRequest, 'AddFileForUpload', @success OUT, @name, @filePath` |
| `AddFileForUpload2` | method | `EXEC sp_OAMethod @httpRequest, 'AddFileForUpload2', @success OUT, @name, @filePath, @contentType` |
| `AddHeader` | method | `EXEC sp_OAMethod @httpRequest, 'AddHeader', NULL, @name, @value` |
| `AddMwsSignature` | method | `EXEC sp_OAMethod @httpRequest, 'AddMwsSignature', @success OUT, @domain, @mwsSecretKey` |
| `AddParam` | method | `EXEC sp_OAMethod @httpRequest, 'AddParam', NULL, @name, @value` |
| `AddStringForUpload` | method | `EXEC sp_OAMethod @httpRequest, 'AddStringForUpload', @success OUT, @name, @filename, @strData, @charset` |
| `AddStringForUpload2` | method | `EXEC sp_OAMethod @httpRequest, 'AddStringForUpload2', @success OUT, @name, @filename, @strData, @charset, @contentType` |
| `AddSubHeader` | method | `EXEC sp_OAMethod @httpRequest, 'AddSubHeader', @success OUT, @index, @name, @value` |
| `GenerateRequestFile` | method | `EXEC sp_OAMethod @httpRequest, 'GenerateRequestFile', @success OUT, @path` |
| `GenerateRequestText` | method | `EXEC sp_OAMethod @httpRequest, 'GenerateRequestText', @sResult OUT` |
| `GetHeaderField` | method | `EXEC sp_OAMethod @httpRequest, 'GetHeaderField', @sResult OUT, @name` |
| `GetHeaderName` | method | `EXEC sp_OAMethod @httpRequest, 'GetHeaderName', @sResult OUT, @index` |
| `GetHeaderValue` | method | `EXEC sp_OAMethod @httpRequest, 'GetHeaderValue', @sResult OUT, @index` |
| `GetParam` | method | `EXEC sp_OAMethod @httpRequest, 'GetParam', @sResult OUT, @name` |
| `GetParamName` | method | `EXEC sp_OAMethod @httpRequest, 'GetParamName', @sResult OUT, @index` |
| `GetParamValue` | method | `EXEC sp_OAMethod @httpRequest, 'GetParamValue', @sResult OUT, @index` |
| `GetUrlEncodedParams` | method | `EXEC sp_OAMethod @httpRequest, 'GetUrlEncodedParams', @sResult OUT` |
| `LoadBodyFromBd` | method | `EXEC sp_OAMethod @httpRequest, 'LoadBodyFromBd', @success OUT, @requestBody` |
| `LoadBodyFromFile` | method | `EXEC sp_OAMethod @httpRequest, 'LoadBodyFromFile', @success OUT, @filePath` |
| `LoadBodyFromSb` | method | `EXEC sp_OAMethod @httpRequest, 'LoadBodyFromSb', @success OUT, @requestBody, @charset` |
| `LoadBodyFromString` | method | `EXEC sp_OAMethod @httpRequest, 'LoadBodyFromString', @success OUT, @bodyStr, @charset` |
| `RemoveAllParams` | method | `EXEC sp_OAMethod @httpRequest, 'RemoveAllParams', NULL` |
| `RemoveHeader` | method | `EXEC sp_OAMethod @httpRequest, 'RemoveHeader', @success OUT, @name` |
| `RemoveParam` | method | `EXEC sp_OAMethod @httpRequest, 'RemoveParam', NULL, @name` |
| `SetFromUrl` | method | `EXEC sp_OAMethod @httpRequest, 'SetFromUrl', NULL, @url` |
| `StreamBodyFromFile` | method | `EXEC sp_OAMethod @httpRequest, 'StreamBodyFromFile', @success OUT, @filePath` |
| `StreamChunkFromFile` | method | `EXEC sp_OAMethod @httpRequest, 'StreamChunkFromFile', @success OUT, @path, @offset, @numBytes` |

## Properties

### HttpRequest.Boundary

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

```sql
EXEC sp_OAGetProperty @httpRequest, 'Boundary', @sValue OUT
EXEC sp_OASetProperty @httpRequest, 'Boundary', @sValue
```

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 · sqlserver · HttpRequest · Charset · property · read/write`

```sql
EXEC sp_OAGetProperty @httpRequest, 'Charset', @sValue OUT
EXEC sp_OASetProperty @httpRequest, 'Charset', @sValue
```

**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 · sqlserver · HttpRequest · ContentType · property · read/write`

```sql
EXEC sp_OAGetProperty @httpRequest, 'ContentType', @sValue OUT
EXEC sp_OASetProperty @httpRequest, 'ContentType', @sValue
```

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 · sqlserver · HttpRequest · EntireHeader · property · read/write`

```sql
EXEC sp_OAGetProperty @httpRequest, 'EntireHeader', @sValue OUT
EXEC sp_OASetProperty @httpRequest, 'EntireHeader', @sValue
```

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

### HttpRequest.HttpVerb

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

```sql
EXEC sp_OAGetProperty @httpRequest, 'HttpVerb', @sValue OUT
EXEC sp_OASetProperty @httpRequest, 'HttpVerb', @sValue
```

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 · sqlserver · HttpRequest · HttpVersion · property · read/write`

```sql
EXEC sp_OAGetProperty @httpRequest, 'HttpVersion', @sValue OUT
EXEC sp_OASetProperty @httpRequest, 'HttpVersion', @sValue
```

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 · sqlserver · HttpRequest · NumHeaderFields · property · read-only`

```sql
EXEC sp_OAGetProperty @httpRequest, 'NumHeaderFields', @iValue OUT
```

Returns the number of request header fields.

### HttpRequest.NumParams

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

```sql
EXEC sp_OAGetProperty @httpRequest, 'NumParams', @iValue OUT
```

Returns the number of query parameters.

### HttpRequest.Path

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

```sql
EXEC sp_OAGetProperty @httpRequest, 'Path', @sValue OUT
EXEC sp_OASetProperty @httpRequest, 'Path', @sValue
```

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 · sqlserver · HttpRequest · SendCharset · property · read/write`

```sql
EXEC sp_OAGetProperty @httpRequest, 'SendCharset', @iValue OUT
EXEC sp_OASetProperty @httpRequest, 'SendCharset', @iValue
```

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

## Methods

### HttpRequest.AddBdForUpload

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

```sql
EXEC sp_OAMethod @httpRequest, 'AddBdForUpload', @success OUT, @name, @remoteFilename, @byteData, @contentType
```

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 1 for success, 0 for failure.

### HttpRequest.AddFileForUpload

`Chilkat 11.7.0 · sqlserver · HttpRequest · AddFileForUpload · method`

```sql
EXEC sp_OAMethod @httpRequest, 'AddFileForUpload', @success OUT, @name, @filePath
```

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 1 for success, 0 for failure.

### HttpRequest.AddFileForUpload2

`Chilkat 11.7.0 · sqlserver · HttpRequest · AddFileForUpload2 · method`

```sql
EXEC sp_OAMethod @httpRequest, 'AddFileForUpload2', @success OUT, @name, @filePath, @contentType
```

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 1 for success, 0 for failure.

### HttpRequest.AddHeader

`Chilkat 11.7.0 · sqlserver · HttpRequest · AddHeader · method`

```sql
EXEC sp_OAMethod @httpRequest, 'AddHeader', NULL, @name, @value
```

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 · sqlserver · HttpRequest · AddMwsSignature · method · since 9.5.0.66`

```sql
EXEC sp_OAMethod @httpRequest, 'AddMwsSignature', @success OUT, @domain, @mwsSecretKey
```

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 1 for success, 0 for failure.

### HttpRequest.AddParam

`Chilkat 11.7.0 · sqlserver · HttpRequest · AddParam · method`

```sql
EXEC sp_OAMethod @httpRequest, 'AddParam', NULL, @name, @value
```

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 · sqlserver · HttpRequest · AddStringForUpload · method`

```sql
EXEC sp_OAMethod @httpRequest, 'AddStringForUpload', @success OUT, @name, @filename, @strData, @charset
```

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

Returns 1 for success, 0 for failure.

### HttpRequest.AddStringForUpload2

`Chilkat 11.7.0 · sqlserver · HttpRequest · AddStringForUpload2 · method`

```sql
EXEC sp_OAMethod @httpRequest, 'AddStringForUpload2', @success OUT, @name, @filename, @strData, @charset, @contentType
```

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 1 for success, 0 for failure.

### HttpRequest.AddSubHeader

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

```sql
EXEC sp_OAMethod @httpRequest, 'AddSubHeader', @success OUT, @index, @name, @value
```

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 1 for success, 0 for failure.

### HttpRequest.GenerateRequestFile

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

```sql
EXEC sp_OAMethod @httpRequest, 'GenerateRequestFile', @success OUT, @path
```

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

Returns 1 for success, 0 for failure.

### HttpRequest.GenerateRequestText

`Chilkat 11.7.0 · sqlserver · HttpRequest · GenerateRequestText · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GenerateRequestText', @sResult OUT
```

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

Returns `NULL` on failure

### HttpRequest.GetHeaderField

`Chilkat 11.7.0 · sqlserver · HttpRequest · GetHeaderField · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GetHeaderField', @sResult OUT, @name
```

Returns the value of a request header field.

Returns `NULL` on failure

### HttpRequest.GetHeaderName

`Chilkat 11.7.0 · sqlserver · HttpRequest · GetHeaderName · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GetHeaderName', @sResult OUT, @index
```

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 `NULL` on failure

### HttpRequest.GetHeaderValue

`Chilkat 11.7.0 · sqlserver · HttpRequest · GetHeaderValue · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GetHeaderValue', @sResult OUT, @index
```

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 `NULL` on failure

### HttpRequest.GetParam

`Chilkat 11.7.0 · sqlserver · HttpRequest · GetParam · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GetParam', @sResult OUT, @name
```

Returns a request query parameter value by name.

Returns `NULL` on failure

### HttpRequest.GetParamName

`Chilkat 11.7.0 · sqlserver · HttpRequest · GetParamName · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GetParamName', @sResult OUT, @index
```

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 `NULL` on failure

### HttpRequest.GetParamValue

`Chilkat 11.7.0 · sqlserver · HttpRequest · GetParamValue · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GetParamValue', @sResult OUT, @index
```

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 `NULL` on failure

### HttpRequest.GetUrlEncodedParams

`Chilkat 11.7.0 · sqlserver · HttpRequest · GetUrlEncodedParams · method`

```sql
EXEC sp_OAMethod @httpRequest, 'GetUrlEncodedParams', @sResult OUT
```

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 `NULL` on failure

### HttpRequest.LoadBodyFromBd

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

```sql
EXEC sp_OAMethod @httpRequest, 'LoadBodyFromBd', @success OUT, @requestBody
```

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

Returns 1 for success, 0 for failure.

### HttpRequest.LoadBodyFromFile

`Chilkat 11.7.0 · sqlserver · HttpRequest · LoadBodyFromFile · method`

```sql
EXEC sp_OAMethod @httpRequest, 'LoadBodyFromFile', @success OUT, @filePath
```

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 1 for success, 0 for failure.

### HttpRequest.LoadBodyFromSb

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

```sql
EXEC sp_OAMethod @httpRequest, 'LoadBodyFromSb', @success OUT, @requestBody, @charset
```

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 1 for success, 0 for failure.

See also:

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

### HttpRequest.LoadBodyFromString

`Chilkat 11.7.0 · sqlserver · HttpRequest · LoadBodyFromString · method`

```sql
EXEC sp_OAMethod @httpRequest, 'LoadBodyFromString', @success OUT, @bodyStr, @charset
```

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 1 for success, 0 for failure.

### HttpRequest.RemoveAllParams

`Chilkat 11.7.0 · sqlserver · HttpRequest · RemoveAllParams · method`

```sql
EXEC sp_OAMethod @httpRequest, 'RemoveAllParams', NULL
```

Removes all request parameters.

### HttpRequest.RemoveHeader

`Chilkat 11.7.0 · sqlserver · HttpRequest · RemoveHeader · method`

```sql
EXEC sp_OAMethod @httpRequest, 'RemoveHeader', @success OUT, @name
```

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

Returns 1 for success, 0 for failure.

### HttpRequest.RemoveParam

`Chilkat 11.7.0 · sqlserver · HttpRequest · RemoveParam · method`

```sql
EXEC sp_OAMethod @httpRequest, 'RemoveParam', NULL, @name
```

Removes a single HTTP request parameter by name.

### HttpRequest.SetFromUrl

`Chilkat 11.7.0 · sqlserver · HttpRequest · SetFromUrl · method`

```sql
EXEC sp_OAMethod @httpRequest, 'SetFromUrl', NULL, @url
```

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

### HttpRequest.StreamBodyFromFile

`Chilkat 11.7.0 · sqlserver · HttpRequest · StreamBodyFromFile · method`

```sql
EXEC sp_OAMethod @httpRequest, 'StreamBodyFromFile', @success OUT, @filePath
```

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 1 for success, 0 for failure.

### HttpRequest.StreamChunkFromFile

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

```sql
EXEC sp_OAMethod @httpRequest, 'StreamChunkFromFile', @success OUT, @path, @offset, @numBytes
```

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 1 for success, 0 for failure.

## Related classes

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

