Blame doc/html/libxml-schematron.html

Packit 423ecb
Packit 423ecb
Packit 423ecb
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="SHORTCUT ICON" href="/favicon.ico" /><style type="text/css">
Packit 423ecb
TD {font-family: Verdana,Arial,Helvetica}
Packit 423ecb
BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
Packit 423ecb
H1 {font-family: Verdana,Arial,Helvetica}
Packit 423ecb
H2 {font-family: Verdana,Arial,Helvetica}
Packit 423ecb
H3 {font-family: Verdana,Arial,Helvetica}
Packit 423ecb
A:link, A:visited, A:active { text-decoration: underline }
Packit 423ecb
</style><style type="text/css">
Packit 423ecb
      div.deprecated pre.programlisting {border-style: double;border-color:red}
Packit 423ecb
      pre.programlisting {border-style: double;background: #EECFA1}
Packit 423ecb
    </style><title>Module schematron from libxml2</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000">
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module schematron from libxml2

<center>API Menu</center>
<form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="20" value="" /><input name="submit" type="submit" value="Search ..." /></form>
<center>API Indexes</center>
<center>Related links</center>

interface to the XML Schematron validity checking.

Table of Contents

Structure xmlSchematron
struct _xmlSchematron
Packit 423ecb
The content of this structure is not made public by the API.
Packit 423ecb
Structure xmlSchematronParserCtxt
struct _xmlSchematronParserCtxt
Packit 423ecb
The content of this structure is not made public by the API.
Packit 423ecb
Typedef xmlSchematronParserCtxt * xmlSchematronParserCtxtPtr
Packit 423ecb
Typedef xmlSchematron * xmlSchematronPtr
Packit 423ecb
Structure xmlSchematronValidCtxt
struct _xmlSchematronValidCtxt
Packit 423ecb
The content of this structure is not made public by the API.
Packit 423ecb
Typedef xmlSchematronValidCtxt * xmlSchematronValidCtxtPtr
Packit 423ecb
Enum xmlSchematronValidOptions
Packit 423ecb
void	xmlSchematronFree		(xmlSchematronPtr schema)
Packit 423ecb
void	xmlSchematronFreeParserCtxt	(xmlSchematronParserCtxtPtr ctxt)
Packit 423ecb
void	xmlSchematronFreeValidCtxt	(xmlSchematronValidCtxtPtr ctxt)
Packit 423ecb
xmlSchematronParserCtxtPtr	xmlSchematronNewDocParserCtxt	(xmlDocPtr doc)
Packit 423ecb
xmlSchematronParserCtxtPtr	xmlSchematronNewMemParserCtxt	(const char * buffer, 
int size)
Packit 423ecb
xmlSchematronParserCtxtPtr	xmlSchematronNewParserCtxt	(const char * URL)
Packit 423ecb
xmlSchematronValidCtxtPtr	xmlSchematronNewValidCtxt	(xmlSchematronPtr schema, 
int options)
Packit 423ecb
xmlSchematronPtr	xmlSchematronParse	(xmlSchematronParserCtxtPtr ctxt)
Packit 423ecb
void	xmlSchematronSetValidStructuredErrors	(xmlSchematronValidCtxtPtr ctxt, 
xmlStructuredErrorFunc serror,
void * ctx)
Packit 423ecb
int	xmlSchematronValidateDoc	(xmlSchematronValidCtxtPtr ctxt, 
xmlDocPtr instance)
Packit 423ecb
Function type: xmlSchematronValidityErrorFunc
Packit 423ecb
void	xmlSchematronValidityErrorFunc	(void * ctx, 
const char * msg,
... ...)
Packit 423ecb
Packit 423ecb
Function type: xmlSchematronValidityWarningFunc
Packit 423ecb
void	xmlSchematronValidityWarningFunc	(void * ctx, 
const char * msg,
... ...)
Packit 423ecb
Packit 423ecb

Description

Packit 423ecb

Structure xmlSchematron

Structure xmlSchematron
struct _xmlSchematron {
Packit 423ecb
The content of this structure is not made public by the API.
Packit 423ecb
}

Structure xmlSchematronParserCtxt

Structure xmlSchematronParserCtxt
struct _xmlSchematronParserCtxt {
Packit 423ecb
The content of this structure is not made public by the API.
Packit 423ecb
}

Structure xmlSchematronValidCtxt

Structure xmlSchematronValidCtxt
struct _xmlSchematronValidCtxt {
Packit 423ecb
The content of this structure is not made public by the API.
Packit 423ecb
}

Enum xmlSchematronValidOptions

Enum xmlSchematronValidOptions {
Packit 423ecb
    XML_SCHEMATRON_OUT_QUIET = 1 : quiet no report
Packit 423ecb
    XML_SCHEMATRON_OUT_TEXT = 2 : build a textual report
Packit 423ecb
    XML_SCHEMATRON_OUT_XML = 4 : output SVRL
Packit 423ecb
    XML_SCHEMATRON_OUT_ERROR = 8 : output via xmlStructuredErrorFunc
Packit 423ecb
    XML_SCHEMATRON_OUT_FILE = 256 : output to a file descriptor
Packit 423ecb
    XML_SCHEMATRON_OUT_BUFFER = 512 : output to a buffer
Packit 423ecb
    XML_SCHEMATRON_OUT_IO = 1024 : output to I/O mechanism
Packit 423ecb
}
Packit 423ecb

Function: xmlSchematronFree

void	xmlSchematronFree		(xmlSchematronPtr schema)
Packit 423ecb

Deallocate a Schematron structure.

Packit 423ecb
<tt>schema</tt>:a schema structure

Function: xmlSchematronFreeParserCtxt

void	xmlSchematronFreeParserCtxt	(xmlSchematronParserCtxtPtr ctxt)
Packit 423ecb

Free the resources associated to the schema parser context

Packit 423ecb
<tt>ctxt</tt>:the schema parser context

Function: xmlSchematronFreeValidCtxt

void	xmlSchematronFreeValidCtxt	(xmlSchematronValidCtxtPtr ctxt)
Packit 423ecb

Free the resources associated to the schema validation context

Packit 423ecb
<tt>ctxt</tt>:the schema validation context

Function: xmlSchematronNewDocParserCtxt

xmlSchematronParserCtxtPtr	xmlSchematronNewDocParserCtxt	(xmlDocPtr doc)
Packit 423ecb

Create an XML Schematrons parse context for that document. NB. The document may be modified during the parsing process.

Packit 423ecb
<tt>doc</tt>:a preparsed document tree
<tt>Returns</tt>:the parser context or NULL in case of error

Function: xmlSchematronNewMemParserCtxt

xmlSchematronParserCtxtPtr	xmlSchematronNewMemParserCtxt	(const char * buffer, 
int size)
Packit 423ecb

Create an XML Schematrons parse context for that memory buffer expected to contain an XML Schematrons file.

Packit 423ecb
<tt>buffer</tt>:a pointer to a char array containing the schemas
<tt>size</tt>:the size of the array
<tt>Returns</tt>:the parser context or NULL in case of error

Function: xmlSchematronNewParserCtxt

xmlSchematronParserCtxtPtr	xmlSchematronNewParserCtxt	(const char * URL)
Packit 423ecb

Create an XML Schematrons parse context for that file/resource expected to contain an XML Schematrons file.

Packit 423ecb
<tt>URL</tt>:the location of the schema
<tt>Returns</tt>:the parser context or NULL in case of error

Function: xmlSchematronNewValidCtxt

xmlSchematronValidCtxtPtr	xmlSchematronNewValidCtxt	(xmlSchematronPtr schema, 
int options)
Packit 423ecb

Create an XML Schematrons validation context based on the given schema.

Packit 423ecb
<tt>schema</tt>:a precompiled XML Schematrons
<tt>options</tt>:a set of xmlSchematronValidOptions
<tt>Returns</tt>:the validation context or NULL in case of error

Function: xmlSchematronParse

xmlSchematronPtr	xmlSchematronParse	(xmlSchematronParserCtxtPtr ctxt)
Packit 423ecb

parse a schema definition resource and build an internal XML Shema struture which can be used to validate instances.

Packit 423ecb
<tt>ctxt</tt>:a schema validation context
<tt>Returns</tt>:the internal XML Schematron structure built from the resource or NULL in case of error

Function: xmlSchematronSetValidStructuredErrors

void	xmlSchematronSetValidStructuredErrors	(xmlSchematronValidCtxtPtr ctxt, 
xmlStructuredErrorFunc serror,
void * ctx)
Packit 423ecb

Set the structured error callback

Packit 423ecb
<tt>ctxt</tt>:a Schematron validation context
<tt>serror</tt>:the structured error function
<tt>ctx</tt>:the functions context

Function: xmlSchematronValidateDoc

int	xmlSchematronValidateDoc	(xmlSchematronValidCtxtPtr ctxt, 
xmlDocPtr instance)
Packit 423ecb

Validate a tree instance against the schematron

Packit 423ecb
<tt>ctxt</tt>:the schema validation context
<tt>instance</tt>:the document instace tree
<tt>Returns</tt>:0 in case of success, -1 in case of internal error and an error count otherwise.

Function type: xmlSchematronValidityErrorFunc

Function type: xmlSchematronValidityErrorFunc
Packit 423ecb
void	xmlSchematronValidityErrorFunc	(void * ctx, 
const char * msg,
... ...)
Packit 423ecb

Signature of an error callback from a Schematron validation

<tt>ctx</tt>:the validation context
<tt>msg</tt>:the message
<tt>...</tt>:extra arguments

Packit 423ecb

Function type: xmlSchematronValidityWarningFunc

Function type: xmlSchematronValidityWarningFunc
Packit 423ecb
void	xmlSchematronValidityWarningFunc	(void * ctx, 
const char * msg,
... ...)
Packit 423ecb

Signature of a warning callback from a Schematron validation

<tt>ctx</tt>:the validation context
<tt>msg</tt>:the message
<tt>...</tt>:extra arguments

Packit 423ecb

Daniel Veillard

</body></html>