XMLHTTP物件參考

XMLHttpRequest

提供客戶端同http伺服器通訊的協議

Dim HttpReq As New MSXML2.XMLHTTP30
HttpReq.open "GET", "http://localhost/books.xml", False
HttpReq.send
MsgBox HttpReq.responseText

備註

客戶端可以通過XmlHttp物件(MSXML2.XMLHTTP.3.0)向http伺服器傳送請求並使用微軟XML文件物件模型Microsoft® XML Document Object Model (DOM)處理迴應。

XMLHttpRequest成員

屬性

 

onreadystatechange	指定當readyState屬性改變時的事件處理控制程式碼。只寫
readyState	返回當前請求的狀態，只讀.
responseBody	將回應資訊正文以unsigned byte陣列形式返回.只讀
responseStream	以Ado Stream物件的形式返回響應資訊。只讀
responseText	將響應資訊作為字串返回.只讀
responseXML	將響應資訊格式化為Xml Document物件並返回，只讀
status	返回當前請求的http狀態碼.只讀
statusText	返回當前請求的響應行狀態，只讀

 

* 表示此屬性是W3C文件物件模型的擴充套件.

方法

 

abort	取消當前請求
getAllResponseHeaders	獲取響應的所有http頭
getResponseHeader	從響應資訊中獲取指定的http頭
open	建立一個新的http請求，並指定此請求的方法、URL以及驗證資訊(使用者名稱/密碼)
send	傳送請求到http伺服器並接收回應
setRequestHeader	單獨指定請求的某個http頭

 

onreadystatechange

指定當readyState屬性改變時的事件處理控制程式碼

語法

oXMLHttpRequest.onreadystatechange = funcMyHandler;

如下的例子演示當XMLHTTPRequest物件的readyState屬性改變時呼叫HandleStateChange函式，當資料接收完畢後（readystate == 4）此頁面上的一個按鈕將被啟用

var xmlhttp=null;
function PostOrder(xmldoc)
{
var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.5.0");
xmlhttp.Open("POST", "http://myserver/orders/processorder.asp", false);
xmlhttp.onreadystatechange= HandleStateChange;
xmlhttp.Send(xmldoc);
myButton.disabled = true;
}
function HandleStateChange()
{
if (xmlhttp.readyState == 4)
{
myButton.disabled = false;
alert("Result = " + xmlhttp.responseXML.xml);
}
}

備註

此屬性只寫，為W3C文件物件模型的擴充套件.

readyState

返回XMLHTTP請求的當前狀態

語法

lValue = oXMLHttpRequest.readyState;

var XmlHttp;
XmlHttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
function send() {
XmlHttp.onreadystatechange = doHttpReadyStateChange;
XmlHttp.open("GET", "http://localhost/sample.xml", true);
XmlHttp.send();
}
function doHttpReadyStateChange() {
if (XmlHttp.readyState == 4) {
alert("Done");
}
}

備註

變數，此屬性只讀，狀態用長度為4的整型表示.定義如下：

 

0 (未初始化)	物件已建立，但是尚未初始化（尚未呼叫open方法）
1 (初始化)	物件已建立，尚未呼叫send方法
2 (傳送資料)	send方法已呼叫，但是當前的狀態及http頭未知
3 (資料傳送中)	已接收部分資料，因為響應及http頭不全，這時通過responseBody和responseText獲取部分資料會出現錯誤，
4 (完成)	資料接收完畢,此時可以通過通過responseBody和responseText獲取完整的迴應資料

 

responseBody

返回某一格式的伺服器響應資料

語法

strValue = oXMLHttpRequest.responseBody;

var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/books.xml", false);
xmlhttp.send();
alert(xmlhttp.responseBody);

備註

變數，此屬性只讀，以unsigned array格式表示直接從伺服器返回的未經解碼的二進位制資料。

responseStream

以Ado Stream物件的形式返回響應資訊

語法

strValue = oXMLHttpRequest.responseStream;

備註

變數，此屬性只讀，以Ado Stream物件的形式返回響應資訊。

responseText

將響應資訊作為字串返回

語法

strValue = oXMLHttpRequest.responseText;

var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/books.xml", false);
xmlhttp.send();
alert(xmlhttp.responseText);

備註

變數，此屬性只讀，將響應資訊作為字串返回。
XMLHTTP嘗試將響應資訊解碼為Unicode字串，XMLHTTP預設將響應資料的編碼定為UTF-8，如果伺服器返回的資料帶BOM(byte-order mark)，XMLHTTP可以解碼任何UCS-2 (big or little endian)或者UCS-4 資料。注意，如果伺服器返回的是xml文件，此屬性並不處理xml文件中的編碼宣告。你需要使用responseXML來處理。

responseXML

將響應資訊格式化為Xml Document物件並返回

語法

var objDispatch = oXMLHttpRequest.responseXML;

var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/books.xml", false);
xmlhttp.send();
alert(xmlhttp.responseXML.xml);

備註

變數，此屬性只讀，將響應資訊格式化為Xml Document物件並返回。如果響應資料不是有效的XML文件，此屬性本身不返回XMLDOMParseError，可以通過處理過的DOMDocument物件獲取錯誤資訊。

status

返回當前請求的http狀態碼

語法

lValue = oXMLHttpRequest.status;

var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/books.xml", false);
xmlhttp.send();
alert(xmlhttp.status);

返回值

長整形標準http狀態碼，定義如下：

Number	Description
100	Continue
101	Switching protocols
200	OK
201	Created
202	Accepted
203	Non-Authoritative Information
204	No Content
205	Reset Content
206	Partial Content
300	Multiple Choices
301	Moved Permanently
302	Found
303	See Other
304	Not Modified
305	Use Proxy
307	Temporary Redirect
400	Bad Request
401	Unauthorized
402	Payment Required
403	Forbidden
404	Not Found
405	Method Not Allowed
406	Not Acceptable
407	Proxy Authentication Required
408	Request Timeout
409	Conflict
410	Gone
411	Length Required
412	Precondition Failed
413	Request Entity Too Large
414	Request-URI Too Long
415	Unsupported Media Type
416	Requested Range Not Suitable
417	Expectation Failed
500	Internal Server Error
501	Not Implemented
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout
505	HTTP Version Not Supported

 

備註

長整形，此屬性只讀，返回當前請求的http狀態碼,此屬性僅當資料傳送並接收完畢後才可獲取。

statusText

返回當前請求的響應行狀態

語法

strValue = oXMLHttpRequest.statusText;

var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/books.xml", false);
xmlhttp.send();
alert(xmlhttp.statusText);

備註

字串，此屬性只讀，以BSTR返回當前請求的響應行狀態,此屬性僅當資料傳送並接收完畢後才可獲取。

abort

取消當前請求

語法

oXMLHttpRequest.abort();

備註

呼叫此方法後，當前請求返回UNINITIALIZED 狀態。

getAllResponseHeaders

獲取響應的所有http頭

語法

strValue = oXMLHttpRequest.getAllResponseHeaders();

var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/sample.xml", false);
xmlhttp.send();
alert(xmlhttp.getAllResponseHeaders());

輸出由web伺服器返回的http頭資訊:

Server:Microsoft-IIS/5.1
X-Powered-By:ASP.NET
Date:Sat, 07 Jun 2003 23:23:06 GMT
Content-Type:text/xml
Accept-Ranges:bytes
Last Modified:Sat, 06 Jun 2003 17:19:04 GMT
ETag:"a0e2eeba4f2cc31:97f"
Content-Length:9

備註

每個http頭名稱和值用冒號分割，並以\r\n結束。當send方法完成後才可呼叫該方法。

getResponseHeader

從響應資訊中獲取指定的http頭

語法

strValue = oXMLHttpRequest.getResponseHeader(bstrHeader);

var xmlhttp = new ActiveXObject("MSXML2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/sample.xml", false);
xmlhttp.send();
alert(xmlhttp.getResponseHeader("Server"));

輸出http頭中的server列：當前web伺服器的版本及名稱。

備註

當send方法成功後才可呼叫該方法。如果伺服器返回的文件型別為"text/xml", 則這句話xmlhttp.getResponseHeader("Content-Type");將返回字串"text/xml"。可以使用getAllResponseHeaders方法獲取完整的http頭資訊。

open

建立一個新的http請求，並指定此請求的方法、URL以及驗證資訊

語法

oXMLHttpRequest.open(bstrMethod, bstrUrl, varAsync, bstrUser, bstrPassword);

引數

bstrMethod
http方法，例如：POST、GET、PUT及PROPFIND。大小寫不敏感。

bstrUrl
請求的URL地址，可以為絕對地址也可以為相對地址。

varAsync[可選]
布林型，指定此請求是否為非同步方式，預設為true。如果為真，當狀態改變時會呼叫onreadystatechange屬性指定的回撥函式。

bstrUser[可選]
如果伺服器需要驗證，此處指定使用者名稱，如果未指定，當伺服器需要驗證時，會彈出驗證視窗。

bstrPassword[可選]
驗證資訊中的密碼部分，如果使用者名稱為空，則此值將被忽略。

下面的例子演示從伺服器請求book.xml,並顯示其中的book欄位。

var xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET","http://localhost/books.xml", false);
xmlhttp.send();
var book = xmlhttp.responseXML.selectSingleNode("//book[@id='bk101']");
alert(book.xml);

備註

呼叫此方法後，可以呼叫send方法向伺服器傳送資料。

send

傳送請求到http伺服器並接收回應

語法

oXMLHttpRequest.send(varBody);

引數

varBody
欲通過此請求傳送的資料。

xmlhttp = new ActiveXObject("Msxml2.XMLHTTP.3.0");
xmlhttp.open("GET", "http://localhost/sample.xml", false);
xmlhttp.send();
alert(xmlhttp.responseXML.xml);

備註

此方法的同步或非同步方式取決於open方法中的bAsync引數，如果bAsync == False，此方法將會等待請求完成或者超時時才會返回，如果bAsync == True，此方法將立即返回。

This method takes one optional parameter, which is the requestBody to use. The acceptable VARIANT input types are BSTR, SAFEARRAY of UI1 (unsigned bytes), IDispatch to an XML Document Object Model (DOM) object, and IStream *. You can use only chunked encoding (for sending) when sending IStream * input types. The component automatically sets the Content-Length header for all but IStream * input types.

如果傳送的資料為BSTR，則迴應被編碼為utf-8, 必須在適當位置設定一個包含charset的文件型別頭。

If the input type is a SAFEARRAY of UI1, the response is sent as is without additional encoding. The caller must set a Content-Type header with the appropriate content type.

如果傳送的資料為XML DOM object，則迴應將被編碼為在xml文件中宣告的編碼，如果在xml文件中沒有宣告編碼，則使用預設的UTF-8。

If the input type is an IStream *, the response is sent as is without additional encoding. The caller must set a Content-Type header with the appropriate content type.

setRequestHeader

單獨指定請求的某個http頭

語法

oXMLHttpRequest.setRequestHeader(bstrHeader, bstrValue);

引數

bstrHeader
字串，頭名稱。

bstrValue
字串，值。

 

備註

如果已經存在已此名稱命名的http頭，則覆蓋之。此方法必須在open方法後呼叫。