IXMLDOMDocument::get_readyState Method

Indicates the current state of the XML document.

Syntax

HRESULT get_readyState(
    long * value);

Parameters

value

[out] Value that indicates the instantiation and download state of the XML document object. Can be one of the following:

0 (UNINITIALIZED)

The XML object has been created but load has not yet been called.

1 (LOADING)

The load is in progress; reading persisted properties, not yet started parsing data. For purposes of the standard readyState definitions, data should be considered equivalent to BLOB properties.

2 (LOADED)

Completed reading the persisted properties; reading and parsing data, but the object model is not yet available.

3 (INTERACTIVE)

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.

4 (COMPLETED)

Document has been completely loaded, successfully or unsuccessfully.

Return Value

Returns S_OK if successful, or an error code otherwise.