Structure xmlSchemaParserCtxt
struct _xmlSchemaParserCtxt {
The content of this structure is not made public by the API.
} xmlSchemaParserCtxt;
Structure xmlSchemaSAXPlugStruct
struct _xmlSchemaSAXPlug {
The content of this structure is not made public by the API.
} xmlSchemaSAXPlugStruct;
Structure xmlSchemaValidCtxt
struct _xmlSchemaValidCtxt {
The content of this structure is not made public by the API.
} xmlSchemaValidCtxt;
Function type xmlSchemaValidityErrorFunc
void xmlSchemaValidityErrorFunc (void * ctx,
const char * msg,
... ...)
Signature of an error callback from an XSD validation
| ctx: | the validation context |
| msg: | the message |
| ...: | extra arguments |
Function type xmlSchemaValidityLocatorFunc
int xmlSchemaValidityLocatorFunc (void * ctx,
const char ** file,
unsigned long * line)
A schemas validation locator, a callback called by the validator. This is used when file or node informations are not available to find out what file and line number are affected
| ctx: | user provided context |
| file: | returned file information |
| line: | returned line information |
| Returns: | 0 in case of success and -1 in case of error |
Function type xmlSchemaValidityWarningFunc
void xmlSchemaValidityWarningFunc (void * ctx,
const char * msg,
... ...)
Signature of a warning callback from an XSD validation
| ctx: | the validation context |
| msg: | the message |
| ...: | extra arguments |
xmlSchemaDump ()
void xmlSchemaDump (FILE * output,
xmlSchemaPtr schema)
Dump a Schema structure.
| output: | the file output |
| schema: | a schema structure |
xmlSchemaFree ()
void xmlSchemaFree (xmlSchemaPtr schema)
Deallocate a Schema structure.
| schema: | a schema structure |
xmlSchemaFreeParserCtxt ()
void xmlSchemaFreeParserCtxt (xmlSchemaParserCtxtPtr ctxt)
Free the resources associated to the schema parser context
| ctxt: | the schema parser context |
xmlSchemaFreeValidCtxt ()
void xmlSchemaFreeValidCtxt (xmlSchemaValidCtxtPtr ctxt)
Free the resources associated to the schema validation context
| ctxt: | the schema validation context |
xmlSchemaGetParserErrors ()
int xmlSchemaGetParserErrors (xmlSchemaParserCtxtPtr ctxt,
xmlSchemaValidityErrorFunc * err,
xmlSchemaValidityWarningFunc * warn,
void ** ctx)
Get the callback information used to handle errors for a parser context
| ctxt: | a XMl-Schema parser context |
| err: | the error callback result |
| warn: | the warning callback result |
| ctx: | contextual data for the callbacks result |
| Returns: | -1 in case of failure, 0 otherwise |
xmlSchemaGetValidErrors ()
int xmlSchemaGetValidErrors (xmlSchemaValidCtxtPtr ctxt,
xmlSchemaValidityErrorFunc * err,
xmlSchemaValidityWarningFunc * warn,
void ** ctx)
Get the error and warning callback informations
| ctxt: | a XML-Schema validation context |
| err: | the error function result |
| warn: | the warning function result |
| ctx: | the functions context result |
| Returns: | -1 in case of error and 0 otherwise |
xmlSchemaIsValid ()
int xmlSchemaIsValid (xmlSchemaValidCtxtPtr ctxt)
Check if any error was detected during validation.
| ctxt: | the schema validation context |
| Returns: | 1 if valid so far, 0 if errors were detected, and -1 in case of internal error. |
xmlSchemaNewDocParserCtxt ()
xmlSchemaParserCtxtPtr xmlSchemaNewDocParserCtxt (xmlDocPtr doc)
Create an XML Schemas 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 |
xmlSchemaNewMemParserCtxt ()
xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt (const char * buffer,
int size)
Create an XML Schemas parse context for that memory buffer expected to contain an XML Schemas 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 |
xmlSchemaNewParserCtxt ()
xmlSchemaParserCtxtPtr xmlSchemaNewParserCtxt (const char * URL)
Create an XML Schemas parse context for that file/resource expected to contain an XML Schemas file.
| URL: | the location of the schema |
| Returns: | the parser context or NULL in case of error |
xmlSchemaNewValidCtxt ()
xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema)
Create an XML Schemas validation context based on the given schema.
| schema: | a precompiled XML Schemas |
| Returns: | the validation context or NULL in case of error |
xmlSchemaParse ()
xmlSchemaPtr xmlSchemaParse (xmlSchemaParserCtxtPtr 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 Schema structure built from the resource or NULL in case of error |
xmlSchemaSAXPlug ()
xmlSchemaSAXPlugPtr xmlSchemaSAXPlug (xmlSchemaValidCtxtPtr ctxt,
xmlSAXHandlerPtr * sax,
void ** user_data)
Plug a SAX based validation layer in a SAX parsing event flow. The original @saxptr and @dataptr data are replaced by new pointers but the calls to the original will be maintained.
| ctxt: | a schema validation context |
| sax: | a pointer to the original xmlSAXHandlerPtr |
| user_data: | a pointer to the original SAX user data pointer |
| Returns: | a pointer to a data structure needed to unplug the validation layer or NULL in case of errors. |
xmlSchemaSAXUnplug ()
int xmlSchemaSAXUnplug (xmlSchemaSAXPlugPtr plug)
Unplug a SAX based validation layer in a SAX parsing event flow. The original pointers used in the call are restored.
| plug: | a data structure returned by xmlSchemaSAXPlug |
| Returns: | 0 in case of success and -1 in case of failure. |
xmlSchemaSetParserStructuredErrors ()
void xmlSchemaSetParserStructuredErrors (xmlSchemaParserCtxtPtr ctxt,
xmlStructuredErrorFunc serror,
void * ctx)
Set the structured error callback
| ctxt: | a schema parser context |
| serror: | the structured error function |
| ctx: | the functions context |
xmlSchemaSetValidOptions ()
int xmlSchemaSetValidOptions (xmlSchemaValidCtxtPtr ctxt,
int options)
Sets the options to be used during the validation.
| ctxt: | a schema validation context |
| options: | a combination of xmlSchemaValidOption |
| Returns: | 0 in case of success, -1 in case of an API error. |
xmlSchemaSetValidStructuredErrors ()
void xmlSchemaSetValidStructuredErrors (xmlSchemaValidCtxtPtr ctxt,
xmlStructuredErrorFunc serror,
void * ctx)
Set the structured error callback
| ctxt: | a schema validation context |
| serror: | the structured error function |
| ctx: | the functions context |
xmlSchemaValidCtxtGetOptions ()
int xmlSchemaValidCtxtGetOptions (xmlSchemaValidCtxtPtr ctxt)
Get the validation context options.
| ctxt: | a schema validation context |
| Returns: | the option combination or -1 on error. |
xmlSchemaValidCtxtGetParserCtxt ()
xmlParserCtxtPtr xmlSchemaValidCtxtGetParserCtxt (xmlSchemaValidCtxtPtr ctxt)
allow access to the parser context of the schema validation context
| ctxt: | a schema validation context |
| Returns: | the parser context of the schema validation context or NULL in case of error. |
xmlSchemaValidateDoc ()
int xmlSchemaValidateDoc (xmlSchemaValidCtxtPtr ctxt,
xmlDocPtr doc)
Validate a document tree in memory.
| ctxt: | a schema validation context |
| doc: | a parsed document tree |
| Returns: | 0 if the document is schemas valid, a positive error code number otherwise and -1 in case of internal or API error. |
xmlSchemaValidateFile ()
int xmlSchemaValidateFile (xmlSchemaValidCtxtPtr ctxt,
const char * filename,
int options)
Do a schemas validation of the given resource, it will use the SAX streamable validation internally.
| ctxt: | a schema validation context |
| filename: | the URI of the instance |
| options: | a future set of options, currently unused |
| Returns: | 0 if the document is valid, a positive error code number otherwise and -1 in case of an internal or API error. |
xmlSchemaValidateOneElement ()
int xmlSchemaValidateOneElement (xmlSchemaValidCtxtPtr ctxt,
xmlNodePtr elem)
Validate a branch of a tree, starting with the given @elem.
| ctxt: | a schema validation context |
| elem: | an element node |
| Returns: | 0 if the element and its subtree is valid, a positive error code number otherwise and -1 in case of an internal or API error. |
xmlSchemaValidateSetFilename ()
void xmlSchemaValidateSetFilename (xmlSchemaValidCtxtPtr vctxt,
const char * filename)
Workaround to provide file error reporting information when this is not provided by current APIs
| vctxt: | the schema validation context |
| filename: | the file name |
xmlSchemaValidateSetLocator ()
void xmlSchemaValidateSetLocator (xmlSchemaValidCtxtPtr vctxt,
xmlSchemaValidityLocatorFunc f,
void * ctxt)
Allows to set a locator function to the validation context, which will be used to provide file and line information since those are not provided as part of the SAX validation flow Setting @f to NULL disable the locator.
| vctxt: | a schema validation context |
| f: | the locator function pointer |
| ctxt: | the locator context |
xmlSchemaValidateStream ()
int xmlSchemaValidateStream (xmlSchemaValidCtxtPtr ctxt,
xmlParserInputBufferPtr input,
xmlCharEncoding enc,
xmlSAXHandlerPtr sax,
void * user_data)
Validate an input based on a flow of SAX event from the parser and forward the events to the @sax handler with the provided @user_data the user provided @sax handler must be a SAX2 one.
| ctxt: | a schema validation context |
| input: | the input to use for reading the data |
| enc: | an optional encoding information |
| sax: | a SAX handler for the resulting events |
| user_data: | the context to provide to the SAX handler. |
| Returns: | 0 if the document is schemas valid, a positive error code number otherwise and -1 in case of internal or API error. |