HttpRequest ActiveX Reference Documentation

HttpRequest

Current Version: 9.5.0.75

Represents a complete HTTP request.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatHttpRequest

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.HttpRequest")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.HttpRequest")

(Delphi)
obj := TChilkatHttpRequest.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.HttpRequest')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.HttpRequest")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.HttpRequest', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.HttpRequest");

Properties

Boundary
Boundary As String
Introduced in version 9.5.0.49

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.

top
Charset
Charset As String

Controls the character encoding used for HTTP request parameters for POST requests. The default value is the ANSI charset of the computer. The charset should match the charset expected by the form target.

The "charset" attribute is only included in the Content-Type header of the request if the SendCharset property is set to 1.

top
ContentType
ContentType As String

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.

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
EntireHeader
EntireHeader As String

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

top
HttpVerb
HttpVerb As String

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.

top
HttpVersion
HttpVersion As String

The HTTP version in the request header. Defaults to "1.1".

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
NumHeaderFields
NumHeaderFields As Long (read-only)

Returns the number of request header fields.

top
NumParams
NumParams As Long (read-only)

Returns the number of query parameters.

top
Path
Path As String

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

top
SendCharset
SendCharset As Long

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.

top
VerboseLogging
VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "9.5.0.63"

top

Methods

AddBytesForUpload
AddBytesForUpload(name As String, remoteFileName As String, byteData As Variant) As Long

Adds a file to an upload request where the contents of the file come from an in-memory byte array. To create a file upload request, call UseUpload and then call AddBytesForUpload, AddStringForUpload, or AddFileForUpload for each file to be uploaded.

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 contents (bytes) to be uploaded.

Returns 1 for success, 0 for failure.

top
AddBytesForUpload2
AddBytesForUpload2(name As String, remoteFileName As String, byteData As Variant, contentType As String) As Long

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

Returns 1 for success, 0 for failure.

top
AddFileForUpload
AddFileForUpload(name As String, filePath As String) As Long

Adds a file to an upload request. To create a file upload request, call UseUpload 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.

top
AddFileForUpload2
AddFileForUpload2(name As String, filePath As String, contentType As String) As Long

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.

top
AddHeader
AddHeader(name As String, value As String)

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

top
AddMwsSignature
AddMwsSignature(domain As String, mwsSecretKey As String) As Long
Introduced in version 9.5.0.66

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.

top
AddParam
AddParam(name As String, value As String)

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.

top
AddStringForUpload
AddStringForUpload(name As String, filename As String, strData As String, charset As String) As Long

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

Returns 1 for success, 0 for failure.

top
AddStringForUpload2
AddStringForUpload2(name As String, filename As String, strData As String, charset As String, contentType As String) As Long

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.

top
AddSubHeader
AddSubHeader(ByVal index As Long, name As String, value As String) As Long
Introduced in version 9.5.0.55

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.

top
GenerateRequestFile
GenerateRequestFile(path As String) As Long
Introduced in version 9.5.0.64

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

Returns 1 for success, 0 for failure.

top
GenerateRequestText
GenerateRequestText() As String

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

Returns Nothing on failure

top
GetHeaderField
GetHeaderField(name As String) As String

Returns the value of a request header field.

Returns Nothing on failure

top
GetHeaderName
GetHeaderName(ByVal index As Long) As String

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 Nothing on failure

top
GetHeaderValue
GetHeaderValue(ByVal index As Long) As String

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 Nothing on failure

top
GetParam
GetParam(name As String) As String

Returns a request query parameter value by name.

Returns Nothing on failure

top
GetParamName
GetParamName(ByVal index As Long) As String

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 Nothing on failure

top
GetParamValue
GetParamValue(ByVal index As Long) As String

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 Nothing on failure

top
GetUrlEncodedParams
GetUrlEncodedParams() As String

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

Returns Nothing on failure

top
LoadBodyFromBd
LoadBodyFromBd(requestBody As ChilkatBinData) As Long
Introduced in version 9.5.0.67

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

Returns 1 for success, 0 for failure.

top
LoadBodyFromBytes
LoadBodyFromBytes(byteData As Variant) As Long

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 the byteData.
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.

top
LoadBodyFromFile
LoadBodyFromFile(filePath As String) As Long

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.

top
LoadBodyFromSb
LoadBodyFromSb(requestBody As ChilkatStringBuilder, charset As String) As Long
Introduced in version 9.5.0.67

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.

More Information and Examples
top
LoadBodyFromString
LoadBodyFromString(bodyStr As String, charset As String) As Long

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.

top
RemoveAllParams
RemoveAllParams()

Removes all request parameters.

top
RemoveHeader
RemoveHeader(name As String) As Long

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

Returns 1 for success, 0 for failure.

top
RemoveParam
RemoveParam(name As String)

Removes a single HTTP request parameter by name.

top
SetFromUrl
SetFromUrl(url As String)

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

top
StreamBodyFromFile
StreamBodyFromFile(filePath As String) As Long

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.

top
StreamChunkFromFile
StreamChunkFromFile(path As String, offset As String, numBytes As String) As Long
Introduced in version 9.5.0.55

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.

top