source-git / libxml2

Clone
Source Code
GIT

Blame doc/devhelp/libxml2-schematron.html

c8 c8s master
  1.   c8
  2.   doc
  3.   devhelp
  4.   libxml2-schematron.html
Blob History Raw
Packit Service a31ea6
Packit Service a31ea6 
<html>
Packit Service a31ea6 
  <head>
Packit Service a31ea6 
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Packit Service a31ea6 
    <title>schematron: XML Schemastron implementation</title>
Packit Service a31ea6 
    <meta name="generator" content="Libxml2 devhelp stylesheet"/>
Packit Service a31ea6 
    <link rel="start" href="index.html" title="libxml2 Reference Manual"/>
Packit Service a31ea6 
    <link rel="up" href="general.html" title="API"/>
Packit Service a31ea6 
    <link rel="stylesheet" href="style.css" type="text/css"/>
Packit Service a31ea6 
    <link rel="chapter" href="general.html" title="API"/>
Packit Service a31ea6 
  </head>
Packit Service a31ea6 
  <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
            Prev
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
            Up
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
            Home
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
            Next
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        libxml2 Reference Manual
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
      schematron
Packit Service a31ea6
Packit Service a31ea6 
    
schematron - XML Schemastron implementation
Packit Service a31ea6 
    
interface to the XML Schematron validity checking.
Packit Service a31ea6 
    
Author(s): Daniel Veillard
Packit Service a31ea6
Packit Service a31ea6 
      
Synopsis
Packit Service a31ea6 
      
typedef struct _xmlSchematronValidCtxt xmlSchematronValidCtxt;
Packit Service a31ea6 
typedef enum xmlSchematronValidOptions;
Packit Service a31ea6 
typedef xmlSchematron * xmlSchematronPtr;
Packit Service a31ea6 
typedef struct _xmlSchematronParserCtxt xmlSchematronParserCtxt;
Packit Service a31ea6 
typedef struct _xmlSchematron xmlSchematron;
Packit Service a31ea6 
typedef xmlSchematronValidCtxt * xmlSchematronValidCtxtPtr;
Packit Service a31ea6 
typedef xmlSchematronParserCtxt * xmlSchematronParserCtxtPtr;
Packit Service a31ea6 
int	xmlSchematronValidateDoc	(xmlSchematronValidCtxtPtr ctxt, 
					 xmlDocPtr instance);
Packit Service a31ea6 
void	xmlSchematronFreeParserCtxt	(xmlSchematronParserCtxtPtr ctxt);
Packit Service a31ea6 
xmlSchematronParserCtxtPtr	xmlSchematronNewMemParserCtxt	(const char * buffer, 
							 int size);
Packit Service a31ea6 
typedef void xmlSchematronValidityErrorFunc	(void * ctx, 
					 const char * msg, 
					 ... ...);
Packit Service a31ea6 
xmlSchematronParserCtxtPtr	xmlSchematronNewParserCtxt	(const char * URL);
Packit Service a31ea6 
typedef void xmlSchematronValidityWarningFunc	(void * ctx, 
						 const char * msg, 
						 ... ...);
Packit Service a31ea6 
void	xmlSchematronFree		(xmlSchematronPtr schema);
Packit Service a31ea6 
void	xmlSchematronSetValidStructuredErrors	(xmlSchematronValidCtxtPtr ctxt, 
						 xmlStructuredErrorFunc serror, 
						 void * ctx);
Packit Service a31ea6 
void	xmlSchematronFreeValidCtxt	(xmlSchematronValidCtxtPtr ctxt);
Packit Service a31ea6 
xmlSchematronPtr	xmlSchematronParse	(xmlSchematronParserCtxtPtr ctxt);
Packit Service a31ea6 
xmlSchematronParserCtxtPtr	xmlSchematronNewDocParserCtxt	(xmlDocPtr doc);
Packit Service a31ea6 
xmlSchematronValidCtxtPtr	xmlSchematronNewValidCtxt	(xmlSchematronPtr schema, 
							 int options);
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
      
Description
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
      
Details
Packit Service a31ea6
Packit Service a31ea6 
        
Structure xmlSchematron
struct _xmlSchematron {
Packit Service a31ea6 
The content of this structure is not made public by the API.
Packit Service a31ea6 
} xmlSchematron;
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        
Structure xmlSchematronParserCtxt
struct _xmlSchematronParserCtxt {
Packit Service a31ea6 
The content of this structure is not made public by the API.
Packit Service a31ea6 
} xmlSchematronParserCtxt;
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        
Typedef xmlSchematronParserCtxtPtr
xmlSchematronParserCtxt * xmlSchematronParserCtxtPtr;
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        
Typedef xmlSchematronPtr
xmlSchematron * xmlSchematronPtr;
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        
Structure xmlSchematronValidCtxt
struct _xmlSchematronValidCtxt {
Packit Service a31ea6 
The content of this structure is not made public by the API.
Packit Service a31ea6 
} xmlSchematronValidCtxt;
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        
Typedef xmlSchematronValidCtxtPtr
xmlSchematronValidCtxt * xmlSchematronValidCtxtPtr;
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        
Enum xmlSchematronValidOptions
enum xmlSchematronValidOptions {
Packit Service a31ea6 
    XML_SCHEMATRON_OUT_QUIET = 1 /* quiet no report */
Packit Service a31ea6 
    XML_SCHEMATRON_OUT_TEXT = 2 /* build a textual report */
Packit Service a31ea6 
    XML_SCHEMATRON_OUT_XML = 4 /* output SVRL */
Packit Service a31ea6 
    XML_SCHEMATRON_OUT_ERROR = 8 /* output via xmlStructuredErrorFunc */
Packit Service a31ea6 
    XML_SCHEMATRON_OUT_FILE = 256 /* output to a file descriptor */
Packit Service a31ea6 
    XML_SCHEMATRON_OUT_BUFFER = 512 /* output to a buffer */
Packit Service a31ea6 
    XML_SCHEMATRON_OUT_IO = 1024 /*  output to I/O mechanism */
Packit Service a31ea6 
};
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
        
Function type xmlSchematronValidityErrorFunc
void	xmlSchematronValidityErrorFunc	(void * ctx, 
					 const char * msg, 
					 ... ...)
Packit Service a31ea6 
Signature of an error callback from a Schematron validation
Packit Service a31ea6 
<tt>ctx</tt>:the validation context
<tt>msg</tt>:the message
<tt>...</tt>:extra arguments
Packit Service a31ea6
Packit Service a31ea6 
        
Function type xmlSchematronValidityWarningFunc
void	xmlSchematronValidityWarningFunc	(void * ctx, 
						 const char * msg, 
						 ... ...)
Packit Service a31ea6 
Signature of a warning callback from a Schematron validation
Packit Service a31ea6 
<tt>ctx</tt>:the validation context
<tt>msg</tt>:the message
<tt>...</tt>:extra arguments
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronFree ()
void	xmlSchematronFree		(xmlSchematronPtr schema)
Packit Service a31ea6 
Deallocate a Schematron structure.
Packit Service a31ea6 
<tt>schema</tt>:a schema structure
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronFreeParserCtxt ()
void	xmlSchematronFreeParserCtxt	(xmlSchematronParserCtxtPtr ctxt)
Packit Service a31ea6 
Free the resources associated to the schema parser context
Packit Service a31ea6 
<tt>ctxt</tt>:the schema parser context
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronFreeValidCtxt ()
void	xmlSchematronFreeValidCtxt	(xmlSchematronValidCtxtPtr ctxt)
Packit Service a31ea6 
Free the resources associated to the schema validation context
Packit Service a31ea6 
<tt>ctxt</tt>:the schema validation context
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronNewDocParserCtxt ()
xmlSchematronParserCtxtPtr	xmlSchematronNewDocParserCtxt	(xmlDocPtr doc)
Packit Service a31ea6 
Create an XML Schematrons parse context for that document. NB. The document may be modified during the parsing process.
Packit Service a31ea6 
<tt>doc</tt>:a preparsed document tree
<tt>Returns</tt>:the parser context or NULL in case of error
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronNewMemParserCtxt ()
xmlSchematronParserCtxtPtr	xmlSchematronNewMemParserCtxt	(const char * buffer, 
							 int size)
Packit Service a31ea6 
Create an XML Schematrons parse context for that memory buffer expected to contain an XML Schematrons file.
Packit Service a31ea6 
<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
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronNewParserCtxt ()
xmlSchematronParserCtxtPtr	xmlSchematronNewParserCtxt	(const char * URL)
Packit Service a31ea6 
Create an XML Schematrons parse context for that file/resource expected to contain an XML Schematrons file.
Packit Service a31ea6 
<tt>URL</tt>:the location of the schema
<tt>Returns</tt>:the parser context or NULL in case of error
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronNewValidCtxt ()
xmlSchematronValidCtxtPtr	xmlSchematronNewValidCtxt	(xmlSchematronPtr schema, 
							 int options)
Packit Service a31ea6 
Create an XML Schematrons validation context based on the given schema.
Packit Service a31ea6 
<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
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronParse ()
xmlSchematronPtr	xmlSchematronParse	(xmlSchematronParserCtxtPtr ctxt)
Packit Service a31ea6 
parse a schema definition resource and build an internal XML Shema struture which can be used to validate instances.
Packit Service a31ea6 
<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
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronSetValidStructuredErrors ()
void	xmlSchematronSetValidStructuredErrors	(xmlSchematronValidCtxtPtr ctxt, 
						 xmlStructuredErrorFunc serror, 
						 void * ctx)
Packit Service a31ea6 
Set the structured error callback
Packit Service a31ea6 
<tt>ctxt</tt>:a Schematron validation context
<tt>serror</tt>:the structured error function
<tt>ctx</tt>:the functions context
Packit Service a31ea6
Packit Service a31ea6 
        
xmlSchematronValidateDoc ()
int	xmlSchematronValidateDoc	(xmlSchematronValidCtxtPtr ctxt, 
					 xmlDocPtr instance)
Packit Service a31ea6 
Validate a tree instance against the schematron
Packit Service a31ea6 
<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.
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
  </body>
Packit Service a31ea6 
</html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation