xml Property (Compact 2013)

3/26/2014

Contains the XML representation of the node and all its descendants.

Syntax

strValue = oXMLDOMNode.xml;
HRESULT get_xml(  BSTR* xmlString);

Parameters

Script

None.

C/C++

  • xmlString
    [out, retval] XML representation of this node and all its descendants.

Return Value

Script

String. XML representation of this node and all its descendants.

C/C++

  • S_OK
    Value returned if successful.
  • E_INVALIDARG
    Value returned if xmlString is Null.

Remarks

Note that the xml property always returns a Unicode string. That is, the xml property for DOMDocument converts the document from its original encoding to Unicode. As a result, the original encoding attribute is removed. For example, <?xml version="1.0" encoding="UTF-8"?> appears in the xml property as follows.

<?xml version="1.0"?>

If the original encoding was not removed by the xml property, the following line returns an error indicating the parser cannot switch from Unicode to UTF-8 encoding.

xmlDoc.loadxml(xmlDoc.xml);

If you use the save Method, the original encoding is preserved. For example, if you load a document in Microsoft® Windows® 1252 encoding, it will be saved in that format.

This value depends on the value of the nodeType property.

Value

Description

NODE_ATTRIBUTE, NODE_CDATA_SECTION, NODE_COMMENT, NODE_DOCUMENT, NODE_ELEMENT, NODE_ENTITY, NODE_NOTATION, NODE_PROCESSING_INSTRUCTION, NODE_TEXT

Returns the string representation of the node and all its descendants.

NODE_DOCUMENT_FRAGMENT

Returns the string representation of all descendant nodes of the document fragment.

NODE_DOCUMENT_TYPE

Returns the string representation of the <!DOCTYPE ...> declaration, including the internal subset if specified.

NODE_ENTITY_REFERENCE

Returns the string representation of the entity reference. Although the entity reference has children, they are not returned.

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

This property is read-only, and applies to the following objects and interfaces:

IXMLDOMAttribute, IXMLDOMCDATASection, IXMLDOMCharacterData, IXMLDOMComment, DOMDocument, IXMLDOMDocumentFragment, IXMLDOMDocumentType, IXMLDOMElement, IXMLDOMEntity, IXMLDOMEntityReference, IXMLDOMNode, IXMLDOMNotation, IXMLDOMProcessingInstruction, IXMLDOMText, and IXTLRuntime

Requirements

Header

msxml2.h,
msxml2.idl

See Also

Reference

XML DOM Properties
save Method
nodeType Property