Difference between revisions of "xmlread"

From Free Pascal wiki
Jump to navigationJump to search
m
m (Fixed syntax highlighting; deleted category included in page template)
 
Line 1: Line 1:
 +
{{xmlread}}
 +
 
Provides an XML reader, which can read XML data from a file or stream. The data is stored in a [[TXMLDocument]].
 
Provides an XML reader, which can read XML data from a file or stream. The data is stored in a [[TXMLDocument]].
 
   
 
   
 
== Declarations ==
 
== Declarations ==
 +
 
Declarations excerpted from xmlread.pas.
 
Declarations excerpted from xmlread.pas.
<source>
+
 
 +
<syntaxhighlight lang=pascal>
 
procedure ReadXMLFile(out ADoc: TXMLDocument; const AFilename: WideString); overload;
 
procedure ReadXMLFile(out ADoc: TXMLDocument; const AFilename: WideString); overload;
 
procedure ReadXMLFile(out ADoc: TXMLDocument; var f: Text); overload;
 
procedure ReadXMLFile(out ADoc: TXMLDocument; var f: Text); overload;
Line 18: Line 22:
 
procedure ReadDTDFile(out ADoc: TXMLDocument; var f: TStream); overload;
 
procedure ReadDTDFile(out ADoc: TXMLDocument; var f: TStream); overload;
 
procedure ReadDTDFile(out ADoc: TXMLDocument; var f: TStream; const ABaseURI: WideString); overload;
 
procedure ReadDTDFile(out ADoc: TXMLDocument; var f: TStream; const ABaseURI: WideString); overload;
</source>
+
</syntaxhighlight>
  
 
== Encodings ==
 
== Encodings ==
 +
 
The parser can read files encoded in [[UTF-8]], [[UTF-16]] (both endianness), and ISO-8859-1.
 
The parser can read files encoded in [[UTF-8]], [[UTF-16]] (both endianness), and ISO-8859-1.
  
Line 31: Line 36:
  
 
== DTD support ==
 
== DTD support ==
 +
 
It supports DTD validation. Regarding entity references: The pre-defined entities "lt", "gt", "amp", "apos" and "quot", and internal entities declared in DTD, are replaced by their defined values during reading. Ability to resolve external entities is currently limited to the file system.
 
It supports DTD validation. Regarding entity references: The pre-defined entities "lt", "gt", "amp", "apos" and "quot", and internal entities declared in DTD, are replaced by their defined values during reading. Ability to resolve external entities is currently limited to the file system.
  
Line 36: Line 42:
 
Back to [[fcl-xml]] overview.
 
Back to [[fcl-xml]] overview.
  
[[Category:XML]]
 
  
 
== See also ==
 
== See also ==
[[xmlwrite]]
+
 
 +
* [[xmlwrite]]

Latest revision as of 09:09, 3 March 2020

English (en) español (es)

Provides an XML reader, which can read XML data from a file or stream. The data is stored in a TXMLDocument.

Declarations

Declarations excerpted from xmlread.pas.

procedure ReadXMLFile(out ADoc: TXMLDocument; const AFilename: WideString); overload;
procedure ReadXMLFile(out ADoc: TXMLDocument; var f: Text); overload;
procedure ReadXMLFile(out ADoc: TXMLDocument; var f: TStream); overload;
procedure ReadXMLFile(out ADoc: TXMLDocument; var f: TStream; const ABaseURI: WideString); overload;

procedure ReadXMLFragment(AParentNode: TDOMNode; const AFilename: WideString); overload;
procedure ReadXMLFragment(AParentNode: TDOMNode; var f: Text); overload;
procedure ReadXMLFragment(AParentNode: TDOMNode; var f: TStream); overload;
procedure ReadXMLFragment(AParentNode: TDOMNode; var f: TStream; const ABaseURI: WideString); overload;

procedure ReadDTDFile(out ADoc: TXMLDocument; const AFilename: WideString); overload;
procedure ReadDTDFile(out ADoc: TXMLDocument; var f: Text); overload;
procedure ReadDTDFile(out ADoc: TXMLDocument; var f: TStream); overload;
procedure ReadDTDFile(out ADoc: TXMLDocument; var f: TStream; const ABaseURI: WideString); overload;

Encodings

The parser can read files encoded in UTF-8, UTF-16 (both endianness), and ISO-8859-1.

White space handling

Regarding whitespace handling: By default, whitespace directly after the beginning of a tag is discarded, and sections of the XML file which contain only whitespace and no other text content are discarded as well. However, whitespace-preserving mode can be enabled by setting TDOMParser.Options.PreserveWhitespace property to True.

DTD support

It supports DTD validation. Regarding entity references: The pre-defined entities "lt", "gt", "amp", "apos" and "quot", and internal entities declared in DTD, are replaced by their defined values during reading. Ability to resolve external entities is currently limited to the file system.


Back to fcl-xml overview.


See also