0LASubrXmlWriterOpen < Main

Tags: view all tags
---+ .XML WRITER OPEN

_This subroutine creates and opens an XML file. Added in 6.2.0_

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;XML_stream_name&gt;          FIELD            SHARE? N
      PASS         &lt;XML_file_pathname&gt;        FIELD            SHARE? N
      PASS         &lt;encoding&gt;                 FIELD            SHARE? N
      PASS         &lt;version&gt;                  FIELD            SHARE? N
      PASS         &lt;standalone&gt;               FIELD            SHARE? N
      GOSUB    --- .XML WRITER OPEN
      *        Check for errors
      IF       --- .XML WRITER OPEN           NE

</pre>
---++ Description:

This subroutine creates and opens a new XML file. If the file already exists, it will replace it. It also adds the &lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt; tag to it.

&lt;XML_stream_name&gt; is a name that you assign to this XML file. You can use this name in the following calls to add more data to this XML file. This field is required and cannot be more than 22 characters.

&lt;XML_file_pathname&gt; is the XML file path name on the server. If the file already exist, it will be replaced by a new empty file. This field is required and cannot be more than 2048 characters.

&lt;encoding&gt; is the character encoding of the XML file. It is also being added as "encoding" attribute to the &lt;?xml encoding="[encoding]" ?&gt; tag of the file. APPX automatically converts the encoding of the data being written to this xml file. This is an optional parameter and the default value for it is UTF-8.

&lt;version&gt; is an optional parameter which specifies the version of this XML file. Valid versions are "1.0", "1.1", and "2.0". The default value if not passed is "1.0". It is being added as "version" attribute to &lt;?xml version="[version]"?&gt; tag.

&lt;standalone&gt; is another optional parameter which specifies if this XML file is standalone or not. Valid values for this field is "Y" or "N". It is being added as "standalone" attribute to &lt;?xml standalone="[yes/no]"?&gt; tag. If not passed appx assumes default value of "Y" for this field.

You can check the value of --- .XML WRITER OPEN field after the api call to check for errors.

See also [[0LASubrXmlWriterClose][.XML WRITER CLOSE]]
---++ Comments:

_Read what other users have said about this page or add your own comments._

%COMMENT%
Topic revision: r1 - 2022-05-25 - MisaghKarimi