Chilkat C# HttpRequest Class Reference

HttpRequest

Represents a complete HTTP request.

Properties

public string Charset {get; set; }

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.

public string HttpVersion {get; set; }

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

public string LastErrorHtml {get; }

Error information in HTML format for the last method called.

public string LastErrorText {get; }

Error information in plain-text format for the last method called.

public string LastErrorXml {get; }

Error information in XML format for the last method called.

public int NumHeaderFields {get; }

Returns the number of request header fields.

public int NumParams {get; }

Returns the number of query parameters.

public string Path {get; set; }

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

public bool SendCharset {get; set; }

Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request.

Methods

public bool AddFileForUpload(string name, string filename);

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.

public void AddHeader(string name, string value);

Adds a request header to the HTTP request. If a header having the same field name is already present, this method replaces it.

public void AddParam(string name, string 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.

public bool AddStringForUpload(string name, string filename, string strData, string charset);

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

public string GenerateRequestText();

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

Returns a null on failure

public string GetHeaderField(string name);

Returns the value of a request header field.

Returns a null on failure

public string GetHeaderName(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 a null on failure

public string GetHeaderValue(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 a null on failure

public string GetParam(string name);

Returns a request query parameter value by name.

Returns a null on failure

public string GetParamName(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 a null on failure

public string GetParamValue(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 a null on failure

public bool LoadBodyFromBytes(byte[] binaryData);

To be documented soon...

public bool LoadBodyFromFile(string filename);

To be documented soon...

public bool LoadBodyFromString(string bodyStr);

To be documented soon...

public void RemoveAllParams();

Removes all request parameters.

public void RemoveParam(string name);

Removes a single HTTP request parameter by name.

public bool SaveLastError(string filename);

Saves the last error information to an XML formatted file.

public void SetFromUrl(string url);

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

public void UseGet();

Makes the HttpRequest a GET request.

public void UseHead();

Makes the HttpRequest a HEAD request.

public void UsePost();

Makes the HttpRequest a POST request that uses the "application/x-www-form-urlencoded" content type.

public void 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.

public void UseXmlHttp(string xmlBody);

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.