readyState Property (DOMDocument) (Compact 2013)

3/26/2014

Indicates the current state of the XML document.

Syntax

lValue = oXMLDOMDocument.readyState;

HRESULT get_readyState(
  long* value
);

Parameters

Script

None.

C/C++

• value
  [out, retval] Value that indicates the instantiation and download state of the XML document object. It can be one of the following:

  Value	Description
  LOADING (1)	The load is in progress - reading persisted properties, but not yet parsing data. For readyState definitions, data should be considered equivalent to binary large object (BLOB) 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.

Return Value

Script

Long integer. It returns a value that indicates the instantiation and download state of the XML document object. The value can be one of the following:

C/C++

• S_OK
  Value returned if successful.

• E_INVALIDARG
  Value returned if value is Null.

Remarks

This member is an extension of the World Wide Web Consortium (W3C) Document Object Model (DOM).

This property applies to the following interface:

DOMDocument.

Requirements

See Also

Reference

XML DOM Properties