XMLParseFile PowerScript function
Description
Parses an XML file and determines whether the file is well
formed or complies with a specified grammar.
Syntax
|
1 |
<span>XMLParseFile</span> ( <span>xmlfilename</span> {, <span>validationscheme</span> }{, <span>parsingerrors</span> } {, <span>namespaceprocessing</span> {, <span>schemaprocessing</span> {, <span>schemafullchecking</span> }}}) |
|
Argument |
Description |
|---|---|
|
xmlstring |
A string whose value is the name of the |
|
validationscheme (optional) |
A value of the ValSchemeType enumerated
|
|
parsingerrors (optional) |
A string buffer to which error messages |
|
namespaceprocessing (optional) |
A boolean specifying whether name space If validationscheme is set to ValAlways! The default is false. |
|
schemaprocessing (optional) |
A boolean specifying whether schema support If schemaprocessing is true, namespaceprocessing must also The default is false. |
|
schemafullchecking (optional) |
A boolean specifying whether schema constraints Setting schemafullchecking to true has The default is false. |
Return Values
Long. Returns 0 for success and one of
the following negative values if an error occurs:
-
-1 Parsing error
-2 Argument error
Usage
Use XMLParseFile to validate an XML file
against a DTD or XML schema before proceeding with additional processing.
If no DTD or schema is included or referenced in the file, XMLParseFile checks whether
the document contains well-formed XML. If the XML document fails validation
or is not well–formed, XMLParseFile returns
-1.
Because XSD You can also check the well-formedness of an XSD
file because they are in XML format. The validation scheme must
be ValAuto!, which is the default validation scheme.
To suppress the display of message boxes if errors occur,
specify a string value for the parsingerrors argument.
The files pbxercesNN.dll and xerces-c_XX.dll,
where NN represents the PowerBuilder version
and XX represents the Xerces version, must
be deployed with the other PowerBuilder runtime files in the search
path of any application or component that uses this function.
Examples
These statements parse an XML document. If a DTD
is included or referenced, the document is validated. Otherwise
the parser checks for well-formedness. If the document passes validation,
it is imported into a DataWindow control:
|
1 |
long ll_ret<br> <br>ll_ret = XMLParseFile("c: empmydoc.xml")<br>if ll_ret = 0 then dw_1.ImportFile("c: empmydoc.xml") |
These statements parse an XML document and save any errors
in the string variable ls_err. If
errors occur, no message boxes display. If a DTD is included or
referenced, the document is validated. Otherwise the parser checks
for well–formedness:
|
1 |
long ll_ret<br>string ls_err<br>ll_ret = XMLParseFile("c: empmydoc.xml", ls_err) |
These statements parse an XML document. If an XMLSchema is
included or referenced, the document is validated, otherwise the
parser checks for well–formedness:
|
1 |
long ll_ret<br>ll_ret = XMLParseFile("c: empmydoc.xml", TRUE, TRUE) |
These statements parse an XML document, validate against a
given XML schema, and save any errors that occur in a string variable.
If errors occur, no message boxes display. If no schema is included
or referenced in the file, XMLParseFile returns
-1:
|
1 |
long ll_ret<br>string ls_err<br>ll_ret = XMLParseFile("c: empmydoc.xml", ValAlways!,<br>   ls_err, TRUE, TRUE) |
These statements parse an XML document, validate against a
given XML schema, and parse the schema itself for additional errors.
If no schema is included or referenced in the file, XMLParseFile returns
-1:
|
1 |
long ll_ret<br>string ls_err<br>ll_ret = XMLParseFile("c: empmydoc.xml", ValAlways!,<br>   ls_err, TRUE, TRUE, TRUE) |
These statements parse an XML document, validate against a
given DTD, and save any errors that occur in a string variable.
If errors occur, no message boxes display. If no DTD is included
or referenced in the file, XMLParseFile returns –1:
|
1 |
long ll_ret<br>string ls_err<br>ll_ret = XMLParseFile("c: empmydoc.xml", ValAlways!,<br>   ls_err) |
These statements parse an XSD file and test it for well-formedness.
You must use ValAuto! when you parse an XSD file because there is
no external schema associated with it. However, you do not need
to specify the option when you call the function because it is the
default validation method:
|
1 |
long ll_ret<br>ll_ret = XMLParseFile ("c:mydoc.xsd") |
See Also
-
ImportFile in the DataWindow
Reference or online Help