save Method (Compact 2013)

  • Article

3/26/2014

Saves an XML document to the specified location.

Syntax

oXMLDOMDocument.save(destination);

HRESULT save(
  VARIANT destination
);

Parameters

Script

  • destination
    Object. The object can represent a file name, an ASP Response object, a DOMDocument object, or a custom object that supports persistence. See General Remarks.

C/C++

  • destination
    [in] Type of object to save. This object can represent a file name, an ASP Response object, an XML document object, or a custom object that supports persistence. See Remarks.

Return Value

Script

None.

C/C++

  • S_OK
    Value returned if successful.
  • XML_BAD_ENCODING
    The document contains a character that does not belong in the specified encoding. The character must use a numeric entity reference. For example, the Japanese Unicode character 20013 does not fit into the encoding windows-1250 (the Central European alphabet) and therefore must be represented in markup as the numeric entity reference 中 or 中. This version of save does not automatically convert characters to the numeric entity references.
  • E_INVALIDARG
    A string was provided, but it is not a valid file name.
  • E_ACCESSDENIED
    Save operation is not permitted.
  • E_OUTOFMEMORY
    Save must allocate buffers.
  • (Other values)
    Any other file system error can be returned in the save(string) case.

Remarks

The behavior differs based on the object specified by the objTarget parameter.

Object

Description

String

Specifies the file name. Note that this must be a file name rather than a URL. The file is created if necessary and the contents are entirely replaced with the contents of the saved document. This mode is not intended for use from a secure client such as Microsoft® Internet Explorer.

    dim xmldoc
    set xmldoc = Server.CreateObject("Msxml2.DOMDocument")
    xmldoc.load("c:\myfile.xml")
    xmldoc.save(Server.MapPath("sample.xml"))

The Active Server Pages (ASP) Response object sends the document back to the client that invoked the ASP script.

    dim xmldoc
    set xmldoc = Server.CreateObject("Msxml2.DOMDocument")
    xmldoc.load(Server.MapPath("sample.xml"))
    xmldoc.save(Response)

IXMLDocument Object

Duplicates the original document. It is the equivalent of saving the document and reparsing it. The document goes through full persistence through XML markup, thereby testing the persistability of your XML document.

    <script language="jscript">
        var xmldoc1 = new ActiveXObject("Msxml2.DOMDocument");
        var xmldoc2 = new ActiveXObject("Msxml2.DOMDocument");
        xmldoc1.load("sample.xml");
        xmldoc1.save(xmldoc2.XMLDocument);
    </script>

Custom object supporting persistence

Any other custom COM object that supports QueryInterface for IStream, IPersistStream, or IPersistStreamInit can also be provided here, and the document will be saved accordingly. In the IStream case, the IStream Write method will be called as it saves the document; in the IPersistStream case, IPersistStream Load will be called with an IStream that supports the Read, Seek, and Stat methods.

External entity references in DOCTYPE, ENTITY, NOTATION, and XML namespace declarations are not changed; they point to the original document. A saved XML document might not load if the URLs are not accessible from the location in which you saved the document.

Character encoding is based on the encoding attribute in the XML declaration, such as <?xml version="1.0" encoding="windows-1252"?>. When no encoding attribute is specified, the default setting is UTF-8.

Validation is not performed during save, which can result in an invalid document that does not load again because of a specified document type definition (DTD). This member is an extension of the World Wide Web Consortium (W3C) Document Object Model (DOM).

This method applies to the following interface:

DOMDocument.

Requirements

Header

msxml2.h,
msxml2.idl

Library

uuid.lib

See Also

Reference

XML DOM Methods