Microsoft XML SDK 2.6 - XML Reference

IXMLDOMDocument::readyState Method

IXMLDOMDocument::get_readyState Method

Indicates the current state of the XML document.

Visual Basic Syntax

lValue = oXMLDOMDocument.readyState

C/C++ Syntax

HRESULT get_readyState(
    long *value);

Parameters

value [out]
Value that indicates the instantiation and download state of the XML document object. It can be one of the following:
LOADING (1) The load is in progress—reading persisted properties but not yet parsing data. For readyState definitions, data should be considered equivalent to BLOB (binary large object) properties.
LOADED (2) Reading of the persisted properties completed—reading and parsing data, but the object model is not yet available.
INTERACTIVE (3) Some data has been read and parsed, and the object model is now available on the partially retrieved data set. Although the object model is available during this state, it is read-only.
COMPLETED (4) The document has been completely loaded, successfully or unsuccessfully.

C/C++ Return Values

S_OK
Value returned if successful.
E_INVALIDARG
Value returned if value is Null.

Example

See the IXMLDOMDocument::onreadystatechange Event example.

See Also

IXMLDOMDocument Interface