readyState Property (IXMLHTTPRequest) (Compact 2013)

3/26/2014

Represents the state of the request.

Syntax

lValue = oXMLHttpRequest.readyState;

HRESULT get_readyState(long* plState);

Parameters

Script

None.

C/C++

• plState
  [out, retval] State of the request, as an I4 (4-byte integer). The following table shows the defined values.

  (0) UNINITIALIZED	The object has been created, but not initialized (the open Method (IXMLHTTPRequest) has not been called).
  (1) LOADING	The object has been created, but the send Method (IXMLHTTPRequest) has not been called.
  (2) LOADED	send Method (IXMLHTTPRequest) has been called and the status and headers are available, but the response is not yet available.
  (3) INTERACTIVE	Some data has been received. You can call responseBody Property (IXMLHTTPRequest) and responseText Property (IXMLHTTPRequest) to get the current partial results.
  (4) COMPLETED	All the data has been received, and the complete data is available in responseBody Property (IXMLHTTPRequest) and responseText Property (IXMLHTTPRequest).

Return Value

Script

Variant. State of the request, as an I4 (4-byte integer). The following table shows the defined values.

(0) UNINITIALIZED	The object has been created, but not initialized (the open Method (IXMLHTTPRequest) has not been called).
(1) LOADING	The object has been created, but the send Method (IXMLHTTPRequest) has not been called.
(2) LOADED	send Method (IXMLHTTPRequest) has been called and the status and headers are available, but the response is not yet available.
(3) INTERACTIVE	Some data has been received. You can call responseBody Property (IXMLHTTPRequest) and responseText Property (IXMLHTTPRequest) to get the current partial results.
(4) COMPLETED	All the data has been received, and the complete data is available in responseBody Property (IXMLHTTPRequest) and responseText Property (IXMLHTTPRequest).

C/C++

• S_OK
  Value returned if successful.

• E_INVALIDARG
  Value returned if the input argument is NULL.

Remarks

It represents the state of the request as an I4 (4-byte integer).

This property returns a 4-byte integer.

The property is read-only, and applies to the following interface:

IXMLHTTPRequest

Requirements

Header

msxml2.h, msxml2.idl

See Also

Reference

XML HTTP Properties
open Method (IXMLHTTPRequest)
send Method (IXMLHTTPRequest)
responseBody Property (IXMLHTTPRequest)
responseText Property (IXMLHTTPRequest)
status Property (IXMLHTTPRequest)
statusText Property (IXMLHTTPRequest)