Version (XmlDoc property)

From m204wiki
Jump to navigation Jump to search

Version number in "XML declaration" (XmlDoc class)

Version sets or returns value of version in the "XML declaration," if any, at the beginning of the serialized XML document.


%currentString = doc:Version doc:Version = newString

Syntax terms

%currentString The Unicode string value of doc's Version property.
doc An XmlDoc object expression.
newString The Unicode string value to assign to doc's Version property.

Usage notes

  • The initial value of the Version property is the null string. If a document is deserialized into an XmlDoc, its Version property will be the value specified for version in the "XML declaration" of the document, if there is one.
  • If the Version property is the null string, the serialized form of the XmlDoc will not contain an XML declaration.
  • Version may be the null string only if the value of the Encoding and Standalone properties are also the null string.
  • The only supported values for the Version property are:
    • The null string
    • 1.0
    • 1.1 (if Sirius Mods Version 7.5 or higher)
  • As of Sirius Mods Version 7.3, the string values in the method syntax may include only non-null EBCDIC characters that translate to Unicode. As of Sirius Mods Version 7.6, these strings are Unicode or are converted to Unicode. For more information about the effects of this Version 7.6 change, see "Strings and Unicode with the XmlDoc API".


The following example sets the Version and Standalone properties:

begin %doc object xmlDoc %doc:loadXml('<a/>') %doc:version = '1.1' %doc:Standalone = 'yes' %doc:print end

The example result follows:

<?xml version="1.1" standalone="yes"?> <a/>

Request-cancellation errors (for set method)

This list is not exhaustive: it does not include all the errors that are request cancelling.

  • Encoding or Standalone property is not the null string, and newString is the null string.
  • newString is invalid.

See also

  • These methods control whether to display the version: Print and Serial.