--- product: Chilkat product_version: 11.7.0 language: wc language_label: Unicode C class: HttpRequest license: bundle deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/wc_CkHttpRequestWRef.html --- # Chilkat HttpRequest — Unicode C — v11.7.0 > Chilkat 11.7.0 · language=wc · class=HttpRequest > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/HttpRequest.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/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** ```c HCkHttpRequestW instance = CkHttpRequestW_Create(); // ... CkHttpRequestW_Dispose(instance); ``` `HCkHttpRequestW CkHttpRequestW_Create(void);` Creates an instance of the HCkHttpRequestW object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page. `void CkHttpRequestW_Dispose(HCkHttpRequestW handle);` Objects created by calling CkHttpRequestW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkHttpRequestW_Dispose. 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 Unicode C. ## 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` | `void CkHttpRequestW_getDebugLogFilePath(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putDebugLogFilePath(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_debugLogFilePath(HCkHttpRequestW cHandle);` | 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` | `void CkHttpRequestW_getLastErrorHtml(HCkHttpRequestW cHandle, HCkString retval); const wchar_t *CkHttpRequestW_lastErrorHtml(HCkHttpRequestW cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `void CkHttpRequestW_getLastErrorText(HCkHttpRequestW cHandle, HCkString retval); const wchar_t *CkHttpRequestW_lastErrorText(HCkHttpRequestW cHandle);` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `void CkHttpRequestW_getLastErrorXml(HCkHttpRequestW cHandle, HCkString retval); const wchar_t *CkHttpRequestW_lastErrorXml(HCkHttpRequestW cHandle);` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `BOOL CkHttpRequestW_getLastMethodSuccess(HCkHttpRequestW cHandle); void CkHttpRequestW_putLastMethodSuccess(HCkHttpRequestW cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. | | `VerboseLogging` | `BOOL CkHttpRequestW_getVerboseLogging(HCkHttpRequestW cHandle); void CkHttpRequestW_putVerboseLogging(HCkHttpRequestW cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `void CkHttpRequestW_getVersion(HCkHttpRequestW cHandle, HCkString retval); const wchar_t *CkHttpRequestW_version(HCkHttpRequestW cHandle);` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `Boundary` | property, read/write | `void CkHttpRequestW_getBoundary(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putBoundary(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_boundary(HCkHttpRequestW cHandle);` | | `Charset` | property, read/write | `void CkHttpRequestW_getCharset(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putCharset(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_charset(HCkHttpRequestW cHandle);` | | `ContentType` | property, read/write | `void CkHttpRequestW_getContentType(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putContentType(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_contentType(HCkHttpRequestW cHandle);` | | `EntireHeader` | property, read/write | `void CkHttpRequestW_getEntireHeader(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putEntireHeader(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_entireHeader(HCkHttpRequestW cHandle);` | | `HttpVerb` | property, read/write | `void CkHttpRequestW_getHttpVerb(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putHttpVerb(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_httpVerb(HCkHttpRequestW cHandle);` | | `HttpVersion` | property, read/write | `void CkHttpRequestW_getHttpVersion(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putHttpVersion(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_httpVersion(HCkHttpRequestW cHandle);` | | `NumHeaderFields` | property, read-only | `int CkHttpRequestW_getNumHeaderFields(HCkHttpRequestW cHandle);` | | `NumParams` | property, read-only | `int CkHttpRequestW_getNumParams(HCkHttpRequestW cHandle);` | | `Path` | property, read/write | `void CkHttpRequestW_getPath(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putPath(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_path(HCkHttpRequestW cHandle);` | | `SendCharset` | property, read/write | `BOOL CkHttpRequestW_getSendCharset(HCkHttpRequestW cHandle); void CkHttpRequestW_putSendCharset(HCkHttpRequestW cHandle, BOOL newVal);` | | `AddBdForUpload` | method | `BOOL CkHttpRequestW_AddBdForUpload(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *remoteFilename, HCkBinDataW byteData, const wchar_t *contentType);` | | `AddFileForUpload` | method | `BOOL CkHttpRequestW_AddFileForUpload(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *filePath);` | | `AddFileForUpload2` | method | `BOOL CkHttpRequestW_AddFileForUpload2(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *filePath, const wchar_t *contentType);` | | `AddHeader` | method | `void CkHttpRequestW_AddHeader(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *value);` | | `AddMwsSignature` | method | `BOOL CkHttpRequestW_AddMwsSignature(HCkHttpRequestW cHandle, const wchar_t *domain, const wchar_t *mwsSecretKey);` | | `AddParam` | method | `void CkHttpRequestW_AddParam(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *value);` | | `AddStringForUpload` | method | `BOOL CkHttpRequestW_AddStringForUpload(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *filename, const wchar_t *strData, const wchar_t *charset);` | | `AddStringForUpload2` | method | `BOOL CkHttpRequestW_AddStringForUpload2(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *filename, const wchar_t *strData, const wchar_t *charset, const wchar_t *contentType);` | | `AddSubHeader` | method | `BOOL CkHttpRequestW_AddSubHeader(HCkHttpRequestW cHandle, int index, const wchar_t *name, const wchar_t *value);` | | `GenerateRequestFile` | method | `BOOL CkHttpRequestW_GenerateRequestFile(HCkHttpRequestW cHandle, const wchar_t *path);` | | `GenerateRequestText` | method | `BOOL CkHttpRequestW_GenerateRequestText(HCkHttpRequestW cHandle, const wchar_t *outStr); const wchar_t *CkHttpRequestW_generateRequestText(HCkHttpRequestW cHandle);` | | `GetHeaderField` | method | `BOOL CkHttpRequestW_GetHeaderField(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getHeaderField(HCkHttpRequestW cHandle, const wchar_t *name);` | | `GetHeaderName` | method | `BOOL CkHttpRequestW_GetHeaderName(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getHeaderName(HCkHttpRequestW cHandle, int index);` | | `GetHeaderValue` | method | `BOOL CkHttpRequestW_GetHeaderValue(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getHeaderValue(HCkHttpRequestW cHandle, int index);` | | `GetParam` | method | `BOOL CkHttpRequestW_GetParam(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getParam(HCkHttpRequestW cHandle, const wchar_t *name);` | | `GetParamName` | method | `BOOL CkHttpRequestW_GetParamName(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getParamName(HCkHttpRequestW cHandle, int index);` | | `GetParamValue` | method | `BOOL CkHttpRequestW_GetParamValue(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getParamValue(HCkHttpRequestW cHandle, int index);` | | `GetUrlEncodedParams` | method | `BOOL CkHttpRequestW_GetUrlEncodedParams(HCkHttpRequestW cHandle, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getUrlEncodedParams(HCkHttpRequestW cHandle);` | | `LoadBodyFromBd` | method | `BOOL CkHttpRequestW_LoadBodyFromBd(HCkHttpRequestW cHandle, HCkBinDataW requestBody);` | | `LoadBodyFromFile` | method | `BOOL CkHttpRequestW_LoadBodyFromFile(HCkHttpRequestW cHandle, const wchar_t *filePath);` | | `LoadBodyFromSb` | method | `BOOL CkHttpRequestW_LoadBodyFromSb(HCkHttpRequestW cHandle, HCkStringBuilderW requestBody, const wchar_t *charset);` | | `LoadBodyFromString` | method | `BOOL CkHttpRequestW_LoadBodyFromString(HCkHttpRequestW cHandle, const wchar_t *bodyStr, const wchar_t *charset);` | | `RemoveAllParams` | method | `void CkHttpRequestW_RemoveAllParams(HCkHttpRequestW cHandle);` | | `RemoveHeader` | method | `BOOL CkHttpRequestW_RemoveHeader(HCkHttpRequestW cHandle, const wchar_t *name);` | | `RemoveParam` | method | `void CkHttpRequestW_RemoveParam(HCkHttpRequestW cHandle, const wchar_t *name);` | | `SetFromUrl` | method | `void CkHttpRequestW_SetFromUrl(HCkHttpRequestW cHandle, const wchar_t *url);` | | `StreamBodyFromFile` | method | `BOOL CkHttpRequestW_StreamBodyFromFile(HCkHttpRequestW cHandle, const wchar_t *filePath);` | | `StreamChunkFromFile` | method | `BOOL CkHttpRequestW_StreamChunkFromFile(HCkHttpRequestW cHandle, const wchar_t *path, const wchar_t *offset, const wchar_t *numBytes);` | 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 · wc · HttpRequest · Boundary · property · read/write · since 9.5.0.49` ```c void CkHttpRequestW_getBoundary(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putBoundary(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_boundary(HCkHttpRequestW cHandle); ``` 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 · wc · HttpRequest · Charset · property · read/write` ```c void CkHttpRequestW_getCharset(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putCharset(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_charset(HCkHttpRequestW cHandle); ``` **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 · wc · HttpRequest · ContentType · property · read/write` ```c void CkHttpRequestW_getContentType(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putContentType(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_contentType(HCkHttpRequestW cHandle); ``` 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 · wc · HttpRequest · EntireHeader · property · read/write` ```c void CkHttpRequestW_getEntireHeader(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putEntireHeader(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_entireHeader(HCkHttpRequestW cHandle); ``` Composes and returns the entire MIME header of the HTTP request. ### HttpRequest.HttpVerb `Chilkat 11.7.0 · wc · HttpRequest · HttpVerb · property · read/write` ```c void CkHttpRequestW_getHttpVerb(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putHttpVerb(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_httpVerb(HCkHttpRequestW cHandle); ``` 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 · wc · HttpRequest · HttpVersion · property · read/write` ```c void CkHttpRequestW_getHttpVersion(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putHttpVersion(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_httpVersion(HCkHttpRequestW cHandle); ``` 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 · wc · HttpRequest · NumHeaderFields · property · read-only` ```c int CkHttpRequestW_getNumHeaderFields(HCkHttpRequestW cHandle); ``` Returns the number of request header fields. ### HttpRequest.NumParams `Chilkat 11.7.0 · wc · HttpRequest · NumParams · property · read-only` ```c int CkHttpRequestW_getNumParams(HCkHttpRequestW cHandle); ``` Returns the number of query parameters. ### HttpRequest.Path `Chilkat 11.7.0 · wc · HttpRequest · Path · property · read/write` ```c void CkHttpRequestW_getPath(HCkHttpRequestW cHandle, HCkString retval); void CkHttpRequestW_putPath(HCkHttpRequestW cHandle, const wchar_t *newVal); const wchar_t *CkHttpRequestW_path(HCkHttpRequestW cHandle); ``` 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 · wc · HttpRequest · SendCharset · property · read/write` ```c BOOL CkHttpRequestW_getSendCharset(HCkHttpRequestW cHandle); void CkHttpRequestW_putSendCharset(HCkHttpRequestW cHandle, BOOL newVal); ``` 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 · wc · HttpRequest · AddBdForUpload · method · since 9.5.0.76` ```c BOOL CkHttpRequestW_AddBdForUpload(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *remoteFilename, HCkBinDataW byteData, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.AddFileForUpload `Chilkat 11.7.0 · wc · HttpRequest · AddFileForUpload · method` ```c BOOL CkHttpRequestW_AddFileForUpload(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.AddFileForUpload2 `Chilkat 11.7.0 · wc · HttpRequest · AddFileForUpload2 · method` ```c BOOL CkHttpRequestW_AddFileForUpload2(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *filePath, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.AddHeader `Chilkat 11.7.0 · wc · HttpRequest · AddHeader · method` ```c void CkHttpRequestW_AddHeader(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *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 · wc · HttpRequest · AddMwsSignature · method · since 9.5.0.66` ```c BOOL CkHttpRequestW_AddMwsSignature(HCkHttpRequestW cHandle, const wchar_t *domain, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.AddParam `Chilkat 11.7.0 · wc · HttpRequest · AddParam · method` ```c void CkHttpRequestW_AddParam(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *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 · wc · HttpRequest · AddStringForUpload · method` ```c BOOL CkHttpRequestW_AddStringForUpload(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *filename, const wchar_t *strData, const wchar_t *charset); ``` 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 · wc · HttpRequest · AddStringForUpload2 · method` ```c BOOL CkHttpRequestW_AddStringForUpload2(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *filename, const wchar_t *strData, const wchar_t *charset, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.AddSubHeader `Chilkat 11.7.0 · wc · HttpRequest · AddSubHeader · method · since 9.5.0.55` ```c BOOL CkHttpRequestW_AddSubHeader(HCkHttpRequestW cHandle, int index, const wchar_t *name, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.GenerateRequestFile `Chilkat 11.7.0 · wc · HttpRequest · GenerateRequestFile · method · since 9.5.0.64` ```c BOOL CkHttpRequestW_GenerateRequestFile(HCkHttpRequestW cHandle, const wchar_t *path); ``` 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 · wc · HttpRequest · GenerateRequestText · method` ```c BOOL CkHttpRequestW_GenerateRequestText(HCkHttpRequestW cHandle, const wchar_t *outStr); const wchar_t *CkHttpRequestW_generateRequestText(HCkHttpRequestW cHandle); ``` Returns the request text that would be sent if Http.SynchronousRequest was called. Returns TRUE for success, FALSE for failure. ### HttpRequest.GetHeaderField `Chilkat 11.7.0 · wc · HttpRequest · GetHeaderField · method` ```c BOOL CkHttpRequestW_GetHeaderField(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getHeaderField(HCkHttpRequestW cHandle, const wchar_t *name); ``` Returns the value of a request header field. Returns TRUE for success, FALSE for failure. ### HttpRequest.GetHeaderName `Chilkat 11.7.0 · wc · HttpRequest · GetHeaderName · method` ```c BOOL CkHttpRequestW_GetHeaderName(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getHeaderName(HCkHttpRequestW cHandle, int 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 TRUE for success, FALSE for failure. ### HttpRequest.GetHeaderValue `Chilkat 11.7.0 · wc · HttpRequest · GetHeaderValue · method` ```c BOOL CkHttpRequestW_GetHeaderValue(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getHeaderValue(HCkHttpRequestW cHandle, int 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 TRUE for success, FALSE for failure. ### HttpRequest.GetParam `Chilkat 11.7.0 · wc · HttpRequest · GetParam · method` ```c BOOL CkHttpRequestW_GetParam(HCkHttpRequestW cHandle, const wchar_t *name, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getParam(HCkHttpRequestW cHandle, const wchar_t *name); ``` Returns a request query parameter value by name. Returns TRUE for success, FALSE for failure. ### HttpRequest.GetParamName `Chilkat 11.7.0 · wc · HttpRequest · GetParamName · method` ```c BOOL CkHttpRequestW_GetParamName(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getParamName(HCkHttpRequestW cHandle, int 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 TRUE for success, FALSE for failure. ### HttpRequest.GetParamValue `Chilkat 11.7.0 · wc · HttpRequest · GetParamValue · method` ```c BOOL CkHttpRequestW_GetParamValue(HCkHttpRequestW cHandle, int index, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getParamValue(HCkHttpRequestW cHandle, int 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 TRUE for success, FALSE for failure. ### HttpRequest.GetUrlEncodedParams `Chilkat 11.7.0 · wc · HttpRequest · GetUrlEncodedParams · method` ```c BOOL CkHttpRequestW_GetUrlEncodedParams(HCkHttpRequestW cHandle, const wchar_t *outStr); const wchar_t *CkHttpRequestW_getUrlEncodedParams(HCkHttpRequestW cHandle); ``` 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¶m2=abc%2D123` Returns TRUE for success, FALSE for failure. ### HttpRequest.LoadBodyFromBd `Chilkat 11.7.0 · wc · HttpRequest · LoadBodyFromBd · method · since 9.5.0.67` ```c BOOL CkHttpRequestW_LoadBodyFromBd(HCkHttpRequestW cHandle, HCkBinDataW requestBody); ``` Uses the contents of the `requestBody` as the HTTP request body. Returns TRUE for success, FALSE for failure. ### HttpRequest.LoadBodyFromFile `Chilkat 11.7.0 · wc · HttpRequest · LoadBodyFromFile · method` ```c BOOL CkHttpRequestW_LoadBodyFromFile(HCkHttpRequestW cHandle, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.LoadBodyFromSb `Chilkat 11.7.0 · wc · HttpRequest · LoadBodyFromSb · method · since 9.5.0.67` ```c BOOL CkHttpRequestW_LoadBodyFromSb(HCkHttpRequestW cHandle, HCkStringBuilderW requestBody, const wchar_t *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 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 · wc · HttpRequest · LoadBodyFromString · method` ```c BOOL CkHttpRequestW_LoadBodyFromString(HCkHttpRequestW cHandle, const wchar_t *bodyStr, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.RemoveAllParams `Chilkat 11.7.0 · wc · HttpRequest · RemoveAllParams · method` ```c void CkHttpRequestW_RemoveAllParams(HCkHttpRequestW cHandle); ``` Removes all request parameters. ### HttpRequest.RemoveHeader `Chilkat 11.7.0 · wc · HttpRequest · RemoveHeader · method` ```c BOOL CkHttpRequestW_RemoveHeader(HCkHttpRequestW cHandle, const wchar_t *name); ``` 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 · wc · HttpRequest · RemoveParam · method` ```c void CkHttpRequestW_RemoveParam(HCkHttpRequestW cHandle, const wchar_t *name); ``` Removes a single HTTP request parameter by name. ### HttpRequest.SetFromUrl `Chilkat 11.7.0 · wc · HttpRequest · SetFromUrl · method` ```c void CkHttpRequestW_SetFromUrl(HCkHttpRequestW cHandle, const wchar_t *url); ``` Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue). ### HttpRequest.StreamBodyFromFile `Chilkat 11.7.0 · wc · HttpRequest · StreamBodyFromFile · method` ```c BOOL CkHttpRequestW_StreamBodyFromFile(HCkHttpRequestW cHandle, const wchar_t *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 TRUE for success, FALSE for failure. ### HttpRequest.StreamChunkFromFile `Chilkat 11.7.0 · wc · HttpRequest · StreamChunkFromFile · method · since 9.5.0.55` ```c BOOL CkHttpRequestW_StreamChunkFromFile(HCkHttpRequestW cHandle, const wchar_t *path, const wchar_t *offset, const wchar_t *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 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/wc/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/classes/StringBuilder.md)