Object HttpRequest
Description:
HttpRequest is an object that can be used to transfer data between a Web client and a Web server.
The client can use this object to send any HTTP request. This object has multiple versions. This documentation only describes the interface for versions
MSXML2.ServerXMLHTTP.6.0 and
MSXML2.XMLHTTP.6.0.
The
MSXML2.ServerXMLHTTP.6.0 version has additional methods, that allow communication authentication using user certificates.
Any data format can be received or sent. In case of receiving data in the
XML format, the received response can be analyzed using the
Microsoft XML Document Object Model (DOM). See:
How to read common XML files in the application.
Properties and methods:
| abort() | Terminates and closes the HttpRequest object |
|---|
| getAllResponseHeaders() | Reads the values of all the HTTP request headers |
|---|
| getOption() | Returns information about the requested transmission property |
|---|
| getResponseHeader() | Retrieves the value of a specific HTTP request header |
|---|
| onreadystatechange | Specifies the function to be called, when the readyState property is changed |
|---|
| readyState | Reports the status of the request |
|---|
| open() | Sets the method, URL address and authentication information for the requested data transfer |
|---|
| responseBody | Represents the message body as a byte array. |
|---|
| responseStream | Represents the message body as IStream. |
|---|
| responseText | Represents the message body as text. |
|---|
| responseXML | Represents the response entity body as parsed by Microsoft XML Core Services (MSXML). |
|---|
| send() | Sends an HTTP request to the server |
|---|
| setOption() | Sets the requested transmission property |
|---|
| setProxy() | Specifies proxy settings |
|---|
| setProxyCredentials() | Specify proxy authentication credentials |
|---|
| setRequestHeader() | Retrieves the value of a specific HTTP request header |
|---|
| setTimeouts() | Specifies timeout settings for resolving the domain name, establishing the connection to the server, sending the data, and receiving the response |
|---|
| status | Returns the HTTP request status code of the request |
|---|
| waitForResponse() | Allows to suspend execution the requesting server while waiting for an asynchronous send operation to complete |
|---|