Chilkat VB.NET HttpRequest Class Reference
HttpRequest
Represents a complete HTTP request.
Object Creation
(C#)
Chilkat.HttpRequest obj = new Chilkat.HttpRequest();
(VB.NET)
Dim obj As New Chilkat.HttpRequest()
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.
ContentType As String
To be documented soon...
EntireHeader As String
To be documented soon...
HttpVerb As String
To be documented soon...
HttpVersion As String
The HTTP version in the request header. Defaults to "1.1".
LastErrorHtml As String (ReadOnly)
Error information in HTML format for the last method called.
LastErrorText As String (ReadOnly)
Error information in plain-text format for the last method called.
LastErrorXml As String (ReadOnly)
Error information in XML format for the last method called.
NumHeaderFields As Integer (ReadOnly)
Returns the number of request header fields.
NumParams As Integer (ReadOnly)
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 Boolean
Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request.
Methods
Function AddBytesForUpload(ByVal name As String, ByVal remoteFileName As String, ByVal byteData As Byte()) As Boolean
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.
Function AddBytesForUpload2(ByVal name As String, ByVal remoteFileName As String, ByVal byteData As Byte(), ByVal contentType As String) As Boolean
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.)
Function AddFileForUpload(ByVal name As String, ByVal filePath As String) As Boolean
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.
Function AddFileForUpload2(ByVal name As String, ByVal filePath As String, ByVal contentType As String) As Boolean
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.
Sub AddHeader(ByVal name As String, ByVal 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. (VB.NET) Adding Cookies to an HTTP Request (PowerShell) Adding Cookies to an HTTP Request
Sub AddParam(ByVal name As String, ByVal 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.
Function AddStringForUpload(ByVal name As String, ByVal filename As String, ByVal strData As String, ByVal charset As String) As Boolean
Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file.
Function AddStringForUpload2(ByVal name As String, ByVal filename As String, ByVal strData As String, ByVal charset As String, ByVal contentType As String) As Boolean
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 ARG2's file extension.)
Function GenerateRequestText() As String
Returns the request text that would be sent if Http.SynchronousRequest was called. Returns Nothing on failure
Function GetHeaderField(ByVal name As String) As String
Returns the value of a request header field. Returns Nothing on failure
Function GetHeaderName(ByVal index As Integer) 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
Function GetHeaderValue(ByVal index As Integer) 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
Function GetParam(ByVal name As String) As String
Returns a request query parameter value by name. Returns Nothing on failure
Function GetParamName(ByVal index As Integer) 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
Function GetParamValue(ByVal index As Integer) 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
Function GetUrlEncodedParams() As String
To be documented soon. Returns Nothing on failure
Function LoadBodyFromBytes(ByVal byteData As Byte()) As Boolean
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.
Function LoadBodyFromFile(ByVal filePath As String) As Boolean
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.
Function LoadBodyFromString(ByVal bodyStr As String, ByVal charset As String) As Boolean
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.
Sub RemoveAllParams()
Removes all request parameters.
Sub RemoveParam(ByVal name As String)
Removes a single HTTP request parameter by name.
Function SaveLastError(ByVal filename As String) As Boolean
Saves the last error information to an XML formatted file.
Sub SetFromUrl(ByVal url As String)
Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).
Function StreamBodyFromFile(ByVal filename As String) As Boolean
To be documented soon...
Sub UseGet()
Makes the HttpRequest a GET request.
Sub UseHead()
Makes the HttpRequest a HEAD request.
Sub UsePost()
Makes the HttpRequest a POST request that uses the "application/x-www-form-urlencoded" content type.
Sub UsePostMultipartForm()
Makes the HttpRequest a POST request that uses the "multipart/form-data" content type.
Sub UsePut()
Makes the HttpRequest a PUT request.
Sub 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.
Sub UseUploadPut()
To be documented soon...
Sub UseXmlHttp(ByVal xmlBody As String)
Makes the HttpRequest a POST request using the "application/xml" content type. The request body is set to the XML string passed to this method.
|