blob: 334f4c93306abb1a028fa66ab907b64d30a0ffe4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xmlRead" xml:lang="en">
<refnamediv>
<refname>xmlRead</refname>
<refpurpose>Read a XML stream from a local or distant file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
doc = xmlRead(path [, encoding] [, validateDTD])
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>path</term>
<listitem>
<para>a string, the path to the file to read.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>encoding</term>
<listitem>
<para>a string, the file encoding.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>validateDTD</term>
<listitem>
<para>a boolean to indicate if the document must be validated.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>doc</term>
<listitem>
<para>a mlist typed XMLDoc</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>Read and parse a XML file. The returned document allows to access to the DOM tree which is kept in memory.</para>
<para>If validateDTD is set to true, the document will be validated or not during the parsing operation.</para>
<para>The encoding argument is used to precise the file encoding.</para>
<para>
It is important to notice that the tree must be freed (to avoid memory leaks) with the function <link linkend="xmlDelete">xmlDelete</link>.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
doc = xmlRead("http://www.w3.org/TR/2009/REC-xml-names-20091208/xml-names-10-3e.xml");
e = doc.root.children(1).children(1)
e.name
e.content
xmlDump(e)
// Now we can retrieve all the nodes with an 'href' attribute
q = xmlXPath(doc, "//*[@href]");
q(1).attributes.href
// We delete the doc
xmlDelete(doc);
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="xmlReadStr">xmlReadStr</link>
</member>
<member>
<link linkend="xmlGetOpenDocs">xmlGetOpenDocs</link>
</member>
<member>
<link linkend="xmlDelete">xmlDelete</link>
</member>
<member>
<link linkend="xmlDocument">xmlDocument</link>
</member>
<member>
<link linkend="xmlXPath">xmlXPath</link>
</member>
<member>
<link linkend="xmlValidate">xmlValidate</link>
</member>
</simplelist>
</refsection>
<refsection>
<title>History</title>
<revhistory>
<revision>
<revnumber>5.4.0</revnumber>
<revremark>XML module introduced.</revremark>
</revision>
<revision>
<revnumber>5.5.0</revnumber>
<revremark>Add new argument to select file encoding.</revremark>
</revision>
</revhistory>
</refsection>
</refentry>
|
