deps/src/libxml2-2.9.1/doc/devhelp/libxml2-schematron.html
| | | | | libxml2 Reference Manual |
schematron - XML Schemastron implementation
interface to the XML Schematron validity checking.
Author(s): Daniel Veillard
typedef struct _xmlSchematronValidCtxt[xmlSchematronValidCtxt](#xmlSchematronValidCtxt);
typedef enum[xmlSchematronValidOptions](#xmlSchematronValidOptions);
typedef[xmlSchematron](libxml2-schematron.html#xmlSchematron)*[xmlSchematronPtr](#xmlSchematronPtr);
typedef struct _xmlSchematronParserCtxt[xmlSchematronParserCtxt](#xmlSchematronParserCtxt);
typedef struct _xmlSchematron[xmlSchematron](#xmlSchematron);
typedef[xmlSchematronValidCtxt](libxml2-schematron.html#xmlSchematronValidCtxt)*[xmlSchematronValidCtxtPtr](#xmlSchematronValidCtxtPtr);
typedef[xmlSchematronParserCtxt](libxml2-schematron.html#xmlSchematronParserCtxt)*[xmlSchematronParserCtxtPtr](#xmlSchematronParserCtxtPtr);
int[xmlSchematronValidateDoc](#xmlSchematronValidateDoc)([xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlDocPtr](libxml2-tree.html#xmlDocPtr)instance);
void[xmlSchematronFreeParserCtxt](#xmlSchematronFreeParserCtxt)([xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)ctxt);[xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)[xmlSchematronNewMemParserCtxt](#xmlSchematronNewMemParserCtxt)(const char * buffer,
int size);
typedef void[xmlSchematronValidityErrorFunc](#xmlSchematronValidityErrorFunc)(void * ctx,
const char * msg,
... ...);[xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)[xmlSchematronNewParserCtxt](#xmlSchematronNewParserCtxt)(const char * URL);
typedef void[xmlSchematronValidityWarningFunc](#xmlSchematronValidityWarningFunc)(void * ctx,
const char * msg,
... ...);
void[xmlSchematronFree](#xmlSchematronFree)([xmlSchematronPtr](libxml2-schematron.html#xmlSchematronPtr)schema);
void[xmlSchematronSetValidStructuredErrors](#xmlSchematronSetValidStructuredErrors)([xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlStructuredErrorFunc](libxml2-xmlerror.html#xmlStructuredErrorFunc)serror,
void * ctx);
void[xmlSchematronFreeValidCtxt](#xmlSchematronFreeValidCtxt)([xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)ctxt);[xmlSchematronPtr](libxml2-schematron.html#xmlSchematronPtr)[xmlSchematronParse](#xmlSchematronParse)([xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)ctxt);[xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)[xmlSchematronNewDocParserCtxt](#xmlSchematronNewDocParserCtxt)([xmlDocPtr](libxml2-tree.html#xmlDocPtr)doc);[xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)[xmlSchematronNewValidCtxt](#xmlSchematronNewValidCtxt)([xmlSchematronPtr](libxml2-schematron.html#xmlSchematronPtr)schema,
int options);
struct _xmlSchematron {
The content of this structure is not made public by the API.
} xmlSchematron;
struct _xmlSchematronParserCtxt {
The content of this structure is not made public by the API.
} xmlSchematronParserCtxt;
[xmlSchematronParserCtxt](libxml2-schematron.html#xmlSchematronParserCtxt)* xmlSchematronParserCtxtPtr;
[xmlSchematron](libxml2-schematron.html#xmlSchematron)* xmlSchematronPtr;
struct _xmlSchematronValidCtxt {
The content of this structure is not made public by the API.
} xmlSchematronValidCtxt;
[xmlSchematronValidCtxt](libxml2-schematron.html#xmlSchematronValidCtxt)* xmlSchematronValidCtxtPtr;
enum[xmlSchematronValidOptions](#xmlSchematronValidOptions){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\_ERROR= 8 /* output via xmlStructuredErrorFunc */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 */
};
void xmlSchematronValidityErrorFunc (void * ctx,
const char * msg,
... ...)
Signature of an error callback from a Schematron validation
| ctx: | the validation context | | msg: | the message | | ...: | extra arguments |
void xmlSchematronValidityWarningFunc (void * ctx,
const char * msg,
... ...)
Signature of a warning callback from a Schematron validation
| ctx: | the validation context | | msg: | the message | | ...: | extra arguments |
void xmlSchematronFree ([xmlSchematronPtr](libxml2-schematron.html#xmlSchematronPtr)schema)
Deallocate a Schematron structure.
| schema: | a schema structure |
void xmlSchematronFreeParserCtxt ([xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)ctxt)
Free the resources associated to the schema parser context
| ctxt: | the schema parser context |
void xmlSchematronFreeValidCtxt ([xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)ctxt)
Free the resources associated to the schema validation context
| ctxt: | the schema validation context |
[xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)xmlSchematronNewDocParserCtxt ([xmlDocPtr](libxml2-tree.html#xmlDocPtr)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 |
[xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)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 |
[xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)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 |
[xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)xmlSchematronNewValidCtxt ([xmlSchematronPtr](libxml2-schematron.html#xmlSchematronPtr)schema,
int options)
Create an XML Schematrons validation context based on the given schema.
| schema: | a precompiled XML Schematrons | | options: | a set of xmlSchematronValidOptions | | Returns: | the validation context or NULL in case of error |
[xmlSchematronPtr](libxml2-schematron.html#xmlSchematronPtr)xmlSchematronParse ([xmlSchematronParserCtxtPtr](libxml2-schematron.html#xmlSchematronParserCtxtPtr)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 |
void xmlSchematronSetValidStructuredErrors ([xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlStructuredErrorFunc](libxml2-xmlerror.html#xmlStructuredErrorFunc)serror,
void * ctx)
Set the structured error callback
| ctxt: | a Schematron validation context | | serror: | the structured error function | | ctx: | the functions context |
int xmlSchematronValidateDoc ([xmlSchematronValidCtxtPtr](libxml2-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlDocPtr](libxml2-tree.html#xmlDocPtr)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. |