ChilkatHttpRequest ActiveX Reference
ChilkatHttpRequest
Represents a complete HTTP request.
Properties
Charset As String
Controls the character encoding used for HTTP request parameters for POST requests. The default value is "utf-8". The charset should match the charset expected by the form target.
HttpVersion As String
The HTTP version in the request header. Defaults to "1.1".
LastErrorHtml As String (read-only)
Error information in HTML format for the last method called.
LastErrorText As String (read-only)
Error information in plain-text format for the last method called.
LastErrorXml As String (read-only)
Error information in XML format for the last method called.
NumHeaderFields As Long (read-only)
Returns the number of request header fields.
NumParams As Long (read-only)
Returns the number of query parameters.
Path As String
The path of the resource requested. A path of "/" indicates the default document for a domain.
SendCharset As Long
Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request.
Methods
AddFileForUpload(name As String, filename As String) As Long
Adds a file to an upload request. To create a file upload request, call UseUpload and then call AddFileForUpload for each file to be uploaded.
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.
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.
GenerateRequestText() As String
Returns the request text that would be sent if Http.SynchronousRequest was called. Returns a null on failure
GetHeaderField(name As String) As String
Returns the value of a request header field. Returns a null on failure
GetHeaderName(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 a null on failure
GetHeaderValue(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 a null on failure
GetParam(name As String) As String
Returns a request query parameter value by name. Returns a null on failure
GetParamName(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 a null on failure
GetParamValue(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 a null on failure
LoadBodyFromBytes(binaryData As Variant) As Long
To be documented soon...
LoadBodyFromFile(filename As String) As Long
To be documented soon...
LoadBodyFromString(bodyStr As String) As Long
To be documented soon...
RemoveAllParams()
Removes all request parameters.
RemoveParam(name As String)
Removes a single HTTP request parameter by name.
SaveLastError(filename As String) As Long
Saves the last error information to an XML formatted file.
Serialize() As String
Serializes the HttpRequest object to a string. Returns a null on failure
SetFromUrl(url As String)
Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).
UseGet()
Makes the HttpRequest a GET request.
UseHead()
Makes the HttpRequest a HEAD request.
UsePost()
Makes the HttpRequest a POST request that uses the "application/x-www-form-urlencoded" content type.
UseUpload()
Makes the HttpRequest a POST request that uses the "multipart/form-data" content type. To create a file upload request, call UseUpload and then call AddFileForUpload for each file to be uploaded.
UseXmlHttp(xmlDoc As String)
Makes the HttpRequest a POST request using the "text/xml" content type. The request body is set to the XML string passed to this method.
|