deps/src/libxml2-2.9.1/doc/html/libxml-schematron.html
| |
|
|
|
|
|
|
|
|
|
| API Menu | |
|
| API Indexes | |
|
| Related links | |
|
|
|
|
|
|
| | schemasInternals | | API documentation | | The XML C parser and toolkit of Gnome | threads | |
interface to the XML Schematron validity checking.
Structure[xmlSchematron](#xmlSchematron)
struct _xmlSchematron
The content of this structure is not made public by the API.
Structure[xmlSchematronParserCtxt](#xmlSchematronParserCtxt)
struct _xmlSchematronParserCtxt
The content of this structure is not made public by the API.
Typedef[xmlSchematronParserCtxt](libxml-schematron.html#xmlSchematronParserCtxt)*xmlSchematronParserCtxtPtr
Typedef[xmlSchematron](libxml-schematron.html#xmlSchematron)*xmlSchematronPtr
Structure[xmlSchematronValidCtxt](#xmlSchematronValidCtxt)
struct _xmlSchematronValidCtxt
The content of this structure is not made public by the API.
Typedef[xmlSchematronValidCtxt](libxml-schematron.html#xmlSchematronValidCtxt)*xmlSchematronValidCtxtPtr
Enum[xmlSchematronValidOptions](#xmlSchematronValidOptions)
void[xmlSchematronFree](#xmlSchematronFree)([xmlSchematronPtr](libxml-schematron.html#xmlSchematronPtr)schema)
void[xmlSchematronFreeParserCtxt](#xmlSchematronFreeParserCtxt)([xmlSchematronParserCtxtPtr](libxml-schematron.html#xmlSchematronParserCtxtPtr)ctxt)
void[xmlSchematronFreeValidCtxt](#xmlSchematronFreeValidCtxt)([xmlSchematronValidCtxtPtr](libxml-schematron.html#xmlSchematronValidCtxtPtr)ctxt)
[xmlSchematronParserCtxtPtr](libxml-schematron.html#xmlSchematronParserCtxtPtr)[xmlSchematronNewDocParserCtxt](#xmlSchematronNewDocParserCtxt)([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)
[xmlSchematronParserCtxtPtr](libxml-schematron.html#xmlSchematronParserCtxtPtr)[xmlSchematronNewMemParserCtxt](#xmlSchematronNewMemParserCtxt)(const char * buffer,
int size)
[xmlSchematronParserCtxtPtr](libxml-schematron.html#xmlSchematronParserCtxtPtr)[xmlSchematronNewParserCtxt](#xmlSchematronNewParserCtxt)(const char * URL)
[xmlSchematronValidCtxtPtr](libxml-schematron.html#xmlSchematronValidCtxtPtr)[xmlSchematronNewValidCtxt](#xmlSchematronNewValidCtxt)([xmlSchematronPtr](libxml-schematron.html#xmlSchematronPtr)schema,
int options)
[xmlSchematronPtr](libxml-schematron.html#xmlSchematronPtr)[xmlSchematronParse](#xmlSchematronParse)([xmlSchematronParserCtxtPtr](libxml-schematron.html#xmlSchematronParserCtxtPtr)ctxt)
void[xmlSchematronSetValidStructuredErrors](#xmlSchematronSetValidStructuredErrors)([xmlSchematronValidCtxtPtr](libxml-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlStructuredErrorFunc](libxml-xmlerror.html#xmlStructuredErrorFunc)serror,
void * ctx)
int[xmlSchematronValidateDoc](#xmlSchematronValidateDoc)([xmlSchematronValidCtxtPtr](libxml-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlDocPtr](libxml-tree.html#xmlDocPtr)instance)
Function type:[xmlSchematronValidityErrorFunc](#xmlSchematronValidityErrorFunc)void[xmlSchematronValidityErrorFunc](#xmlSchematronValidityErrorFunc)(void * ctx,
const char * msg,
... ...)
Function type:[xmlSchematronValidityWarningFunc](#xmlSchematronValidityWarningFunc)void[xmlSchematronValidityWarningFunc](#xmlSchematronValidityWarningFunc)(void * ctx,
const char * msg,
... ...)
Structure xmlSchematron
struct _xmlSchematron {
The content of this structure is not made public by the API.
}
Structure xmlSchematronParserCtxt
struct _xmlSchematronParserCtxt {
The content of this structure is not made public by the API.
}
Structure xmlSchematronValidCtxt
struct _xmlSchematronValidCtxt {
The content of this structure is not made public by the API.
}
Enum xmlSchematronValidOptions {XML\_SCHEMATRON\_OUT\_QUIET= 1 : quiet no reportXML\_SCHEMATRON\_OUT\_TEXT= 2 : build a textual reportXML\_SCHEMATRON\_OUT\_XML= 4 : output SVRLXML\_SCHEMATRON\_OUT\_ERROR= 8 : output via[xmlStructuredErrorFunc](libxml-xmlerror.html#xmlStructuredErrorFunc)XML\_SCHEMATRON\_OUT\_FILE= 256 : output to a file descriptorXML\_SCHEMATRON\_OUT\_BUFFER= 512 : output to a bufferXML\_SCHEMATRON\_OUT\_IO= 1024 : output to I/O mechanism
}
void xmlSchematronFree ([xmlSchematronPtr](libxml-schematron.html#xmlSchematronPtr)schema)
Deallocate a Schematron structure.
| schema: | a schema structure |
void xmlSchematronFreeParserCtxt ([xmlSchematronParserCtxtPtr](libxml-schematron.html#xmlSchematronParserCtxtPtr)ctxt)
Free the resources associated to the schema parser context
| ctxt: | the schema parser context |
void xmlSchematronFreeValidCtxt ([xmlSchematronValidCtxtPtr](libxml-schematron.html#xmlSchematronValidCtxtPtr)ctxt)
Free the resources associated to the schema validation context
| ctxt: | the schema validation context |
[xmlSchematronParserCtxtPtr](libxml-schematron.html#xmlSchematronParserCtxtPtr)xmlSchematronNewDocParserCtxt ([xmlDocPtr](libxml-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](libxml-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](libxml-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](libxml-schematron.html#xmlSchematronValidCtxtPtr)xmlSchematronNewValidCtxt ([xmlSchematronPtr](libxml-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](libxml-schematron.html#xmlSchematronPtr)xmlSchematronParse ([xmlSchematronParserCtxtPtr](libxml-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](libxml-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlStructuredErrorFunc](libxml-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](libxml-schematron.html#xmlSchematronValidCtxtPtr)ctxt,
[xmlDocPtr](libxml-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. |
Function type: xmlSchematronValidityErrorFunc
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 |
Function type: xmlSchematronValidityWarningFunc
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 |
|
|
|
|
|