  
    
    
    
    
    
    
    
  
  
    
      
        
          
libxml2-schemasInternals.html            
Prev          
        
        
          
general.html            
Up          
        
        
          
index.html            
Home          
        
        
          
libxml2-threads.html            
Next          
        
        
libxml2 Reference Manual      
    
    
      
schematron    
    
schematron - XML Schemastron implementation
    
interface to the XML Schematron validity checking. 
    
Author(s): Daniel Veillard 
    
      
Synopsis
      
typedef struct _xmlSchematronValidCtxt #xmlSchematronValidCtxtxmlSchematronValidCtxt ;
typedef enum 
#xmlSchematronValidOptionsxmlSchematronValidOptions ;
typedef 
libxml2-schematron.html#xmlSchematronxmlSchematron  * #xmlSchematronPtrxmlSchematronPtr ;
typedef struct _xmlSchematronParserCtxt 
#xmlSchematronParserCtxtxmlSchematronParserCtxt ;
typedef struct _xmlSchematron 
#xmlSchematronxmlSchematron ;
typedef 
libxml2-schematron.html#xmlSchematronValidCtxtxmlSchematronValidCtxt  * #xmlSchematronValidCtxtPtrxmlSchematronValidCtxtPtr ;
typedef 
libxml2-schematron.html#xmlSchematronParserCtxtxmlSchematronParserCtxt  * #xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr ;
int	
#xmlSchematronValidateDocxmlSchematronValidateDoc 	( libxml2-schematron.html#xmlSchematronValidCtxtPtrxmlSchematronValidCtxtPtr  ctxt, 					 libxml2-tree.html#xmlDocPtrxmlDocPtr  instance);
void	
#xmlSchematronFreeParserCtxtxmlSchematronFreeParserCtxt 	( libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr  ctxt);
libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr 	#xmlSchematronNewMemParserCtxtxmlSchematronNewMemParserCtxt 	(const char * buffer, 							 int size);
typedef void 
#xmlSchematronValidityErrorFuncxmlSchematronValidityErrorFunc 	(void * ctx, 					 const char * msg, 					 ... ...);
libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr 	#xmlSchematronNewParserCtxtxmlSchematronNewParserCtxt 	(const char * URL);
typedef void 
#xmlSchematronValidityWarningFuncxmlSchematronValidityWarningFunc 	(void * ctx, 						 const char * msg, 						 ... ...);
void	
#xmlSchematronFreexmlSchematronFree 		( libxml2-schematron.html#xmlSchematronPtrxmlSchematronPtr  schema);
void	
#xmlSchematronFreeValidCtxtxmlSchematronFreeValidCtxt 	( libxml2-schematron.html#xmlSchematronValidCtxtPtrxmlSchematronValidCtxtPtr  ctxt);
libxml2-schematron.html#xmlSchematronPtrxmlSchematronPtr 	#xmlSchematronParsexmlSchematronParse 	( libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr  ctxt);
libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr 	#xmlSchematronNewDocParserCtxtxmlSchematronNewDocParserCtxt 	( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc);
libxml2-schematron.html#xmlSchematronValidCtxtPtrxmlSchematronValidCtxtPtr 	#xmlSchematronNewValidCtxtxmlSchematronNewValidCtxt 	( libxml2-schematron.html#xmlSchematronPtrxmlSchematronPtr  schema, 							 int options);
    
    
      
Description
    
    
      
Details
      
        
Structure xmlSchematron
struct _xmlSchematron {
The content of this structure is not made public by the API.
} xmlSchematron;
        
        
Structure xmlSchematronParserCtxt
struct _xmlSchematronParserCtxt {
The content of this structure is not made public by the API.
} xmlSchematronParserCtxt;
        
        
Typedef xmlSchematronParserCtxtPtr
libxml2-schematron.html#xmlSchematronParserCtxtxmlSchematronParserCtxt  * xmlSchematronParserCtxtPtr;
        
        
Typedef xmlSchematronPtr
libxml2-schematron.html#xmlSchematronxmlSchematron  * xmlSchematronPtr;
        
        
Structure xmlSchematronValidCtxt
struct _xmlSchematronValidCtxt {
The content of this structure is not made public by the API.
} xmlSchematronValidCtxt;
        
        
Typedef xmlSchematronValidCtxtPtr
libxml2-schematron.html#xmlSchematronValidCtxtxmlSchematronValidCtxt  * xmlSchematronValidCtxtPtr;
        
        
Enum xmlSchematronValidOptions
enum #xmlSchematronValidOptionsxmlSchematronValidOptions  {
    
XML_SCHEMATRON_OUT_QUIET  = 1 /* quiet no report */
    
XML_SCHEMATRON_OUT_TEXT  = 2 /* build a textual report */
    
XML_SCHEMATRON_OUT_XML  = 4 /* output SVRL */
    
XML_SCHEMATRON_OUT_FILE  = 256 /* output to a file descriptor */
    
XML_SCHEMATRON_OUT_BUFFER  = 512 /* output to a buffer */
    
XML_SCHEMATRON_OUT_IO  = 1024 /*  output to I/O mechanism */
};
        
        
Function type xmlSchematronValidityErrorFunc
void	xmlSchematronValidityErrorFunc	(void * ctx, 					 const char * msg, 					 ... ...) ctx: msg: ...:         
        
Function type xmlSchematronValidityWarningFunc
void	xmlSchematronValidityWarningFunc	(void * ctx, 						 const char * msg, 						 ... ...) ctx: msg: ...:         
        
xmlSchematronFree ()
void	xmlSchematronFree		( libxml2-schematron.html#xmlSchematronPtrxmlSchematronPtr  schema)Deallocate a Schematron structure.
schema: a schema structure         
        
xmlSchematronFreeParserCtxt ()
void	xmlSchematronFreeParserCtxt	( libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr  ctxt)Free the resources associated to the schema parser context
ctxt: the schema parser context         
        
xmlSchematronFreeValidCtxt ()
void	xmlSchematronFreeValidCtxt	( libxml2-schematron.html#xmlSchematronValidCtxtPtrxmlSchematronValidCtxtPtr  ctxt)Free the resources associated to the schema validation context
ctxt: the schema validation context         
        
xmlSchematronNewDocParserCtxt ()
libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr 	xmlSchematronNewDocParserCtxt	( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc)Create an XML Schematrons parse context for that document. NB. The document may be modified during the parsing process.
doc: a preparsed document tree Returns: the parser context or NULL in case of error         
        
xmlSchematronNewMemParserCtxt ()
libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr 	xmlSchematronNewMemParserCtxt	(const char * buffer, 							 int size)Create an XML Schematrons parse context for that memory buffer expected to contain an XML Schematrons file.
buffer: a pointer to a char array containing the schemas size: the size of the array Returns: the parser context or NULL in case of error         
        
xmlSchematronNewParserCtxt ()
libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr 	xmlSchematronNewParserCtxt	(const char * URL)Create an XML Schematrons parse context for that file/resource expected to contain an XML Schematrons file.
URL: the location of the schema Returns: the parser context or NULL in case of error         
        
xmlSchematronNewValidCtxt ()
libxml2-schematron.html#xmlSchematronValidCtxtPtrxmlSchematronValidCtxtPtr 	xmlSchematronNewValidCtxt	( libxml2-schematron.html#xmlSchematronPtrxmlSchematronPtr  schema, 							 int options)Create an XML Schematrons validation context based on the given schema.
schema: a precompiled XML Schematrons options: a set of libxml2-schematron.html#xmlSchematronValidOptionsxmlSchematronValidOptions Returns: the validation context or NULL in case of error         
        
xmlSchematronParse ()
libxml2-schematron.html#xmlSchematronPtrxmlSchematronPtr 	xmlSchematronParse	( libxml2-schematron.html#xmlSchematronParserCtxtPtrxmlSchematronParserCtxtPtr  ctxt)parse a schema definition resource and build an internal XML Shema struture which can be used to validate instances.
ctxt: a schema validation context Returns: the internal XML Schematron structure built from the resource or NULL in case of error         
        
xmlSchematronValidateDoc ()
int	xmlSchematronValidateDoc	( libxml2-schematron.html#xmlSchematronValidCtxtPtrxmlSchematronValidCtxtPtr  ctxt, 					 libxml2-tree.html#xmlDocPtrxmlDocPtr  instance)Validate a tree instance against the schematron
ctxt: the schema validation context instance: the document instace tree Returns: 0 in case of success, -1 in case of internal error and an error count otherwise.         
      
    
  
