← Back to branch summary

~ubuntu-branches/ubuntu/maverick/libxml2/maverick

« back to all changes in this revision

Viewing changes to doc/libxml2-api.xml

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2008-06-23 21:19:36 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20080623211936-houumen8pccvs06t
Tags: 2.6.32.dfsg-2ubuntu1
* Merge with Debian; remaining changes:
  - debian/rules: create a udeb for debian-installer, correct libxml2-dev
    Depends to include zlib1g-dev.
  - Build a python-libxml2-dbg package.
  - Link using -Bsymbolic-functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libxml2-api.xml
1328
1328
     <description>interface to the XML Schematron validity checking. </description>
1329
1329
     <author>Daniel Veillard </author>
1330
1330
     <exports symbol='XML_SCHEMATRON_OUT_IO' type='enum'/>
 
1331
     <exports symbol='XML_SCHEMATRON_OUT_ERROR' type='enum'/>
1331
1332
     <exports symbol='XML_SCHEMATRON_OUT_BUFFER' type='enum'/>
1332
1333
     <exports symbol='XML_SCHEMATRON_OUT_FILE' type='enum'/>
1333
1334
     <exports symbol='XML_SCHEMATRON_OUT_XML' type='enum'/>
1347
1348
     <exports symbol='xmlSchematronNewParserCtxt' type='function'/>
1348
1349
     <exports symbol='xmlSchematronValidityWarningFunc' type='function'/>
1349
1350
     <exports symbol='xmlSchematronFree' type='function'/>
 
1351
     <exports symbol='xmlSchematronSetValidStructuredErrors' type='function'/>
1350
1352
     <exports symbol='xmlSchematronFreeValidCtxt' type='function'/>
1351
1353
     <exports symbol='xmlSchematronParse' type='function'/>
1352
1354
     <exports symbol='xmlSchematronNewDocParserCtxt' type='function'/>
2011
2013
     <exports symbol='XML_IO_EFAULT' type='enum'/>
2012
2014
     <exports symbol='XML_HTML_STRUCURE_ERROR' type='enum'/>
2013
2015
     <exports symbol='XML_DTD_INVALID_DEFAULT' type='enum'/>
 
2016
     <exports symbol='XML_FROM_SCHEMATRONV' type='enum'/>
2014
2017
     <exports symbol='XML_DTD_EMPTY_NOTATION' type='enum'/>
2015
2018
     <exports symbol='XML_RNGP_ELEMENT_EMPTY' type='enum'/>
2016
2019
     <exports symbol='XML_SCHEMAP_S4S_ELEM_NOT_ALLOWED' type='enum'/>
2512
2515
     <exports symbol='XML_RNGP_PAT_LIST_ATTR' type='enum'/>
2513
2516
     <exports symbol='XML_IO_EACCES' type='enum'/>
2514
2517
     <exports symbol='XML_ERR_NOTATION_NOT_FINISHED' type='enum'/>
 
2518
     <exports symbol='XML_SCHEMATRONV_ASSERT' type='enum'/>
2515
2519
     <exports symbol='XML_SCHEMAP_COS_ST_RESTRICTS_2_3_2_2' type='enum'/>
2516
2520
     <exports symbol='XML_SCHEMAV_INVALIDATTR' type='enum'/>
2517
2521
     <exports symbol='XML_SCHEMAP_RECURSIVE' type='enum'/>
2593
2597
     <exports symbol='XML_CHECK_NO_PREV' type='enum'/>
2594
2598
     <exports symbol='XML_RNGP_VALUE_NO_CONTENT' type='enum'/>
2595
2599
     <exports symbol='XML_SCHEMAP_UNKNOWN_SIMPLECONTENT_CHILD' type='enum'/>
 
2600
     <exports symbol='XML_TREE_NOT_UTF8' type='enum'/>
2596
2601
     <exports symbol='XML_IO_EAFNOSUPPORT' type='enum'/>
2597
2602
     <exports symbol='XML_SCHEMAP_COS_ST_RESTRICTS_3_3_2_1' type='enum'/>
2598
2603
     <exports symbol='XML_CATALOG_NOT_CATALOG' type='enum'/>
2618
2623
     <exports symbol='XML_ERR_NS_DECL_ERROR' type='enum'/>
2619
2624
     <exports symbol='XML_ERR_INTERNAL_ERROR' type='enum'/>
2620
2625
     <exports symbol='XML_SCHEMAP_COS_ST_RESTRICTS_1_3_1' type='enum'/>
 
2626
     <exports symbol='XML_SCHEMATRONV_REPORT' type='enum'/>
2621
2627
     <exports symbol='XML_ERR_ELEMCONTENT_NOT_FINISHED' type='enum'/>
2622
2628
     <exports symbol='XML_FROM_NAMESPACE' type='enum'/>
2623
2629
     <exports symbol='XML_IO_EBUSY' type='enum'/>
4844
4850
    <enum name='XML_FROM_FTP' file='xmlerror' value='9' type='xmlErrorDomain' info='The FTP module'/>
4845
4851
    <enum name='XML_FROM_HTML' file='xmlerror' value='5' type='xmlErrorDomain' info='The HTML parser'/>
4846
4852
    <enum name='XML_FROM_HTTP' file='xmlerror' value='10' type='xmlErrorDomain' info='The HTTP module'/>
4847
 
    <enum name='XML_FROM_I18N' file='xmlerror' value='27' type='xmlErrorDomain' info=' The module handling character conversion'/>
 
4853
    <enum name='XML_FROM_I18N' file='xmlerror' value='27' type='xmlErrorDomain' info='The module handling character conversion'/>
4848
4854
    <enum name='XML_FROM_IO' file='xmlerror' value='8' type='xmlErrorDomain' info='The Input/Output stack'/>
4849
4855
    <enum name='XML_FROM_MEMORY' file='xmlerror' value='6' type='xmlErrorDomain' info='The memory allocator'/>
4850
4856
    <enum name='XML_FROM_MODULE' file='xmlerror' value='26' type='xmlErrorDomain' info='The dynamically loaded module modul'/>
4857
4863
    <enum name='XML_FROM_RELAXNGV' file='xmlerror' value='19' type='xmlErrorDomain' info='The Relax-NG validator module'/>
4858
4864
    <enum name='XML_FROM_SCHEMASP' file='xmlerror' value='16' type='xmlErrorDomain' info='The W3C XML Schemas parser module'/>
4859
4865
    <enum name='XML_FROM_SCHEMASV' file='xmlerror' value='17' type='xmlErrorDomain' info='The W3C XML Schemas validation module'/>
 
4866
    <enum name='XML_FROM_SCHEMATRONV' file='xmlerror' value='28' type='xmlErrorDomain' info=' The Schematron validator module'/>
4860
4867
    <enum name='XML_FROM_TREE' file='xmlerror' value='2' type='xmlErrorDomain' info='The tree module'/>
4861
4868
    <enum name='XML_FROM_VALID' file='xmlerror' value='23' type='xmlErrorDomain' info='The XML DTD validation with valid context'/>
4862
4869
    <enum name='XML_FROM_WRITER' file='xmlerror' value='25' type='xmlErrorDomain' info='The xmlwriter module'/>
5465
5472
    <enum name='XML_SCHEMAS_ULONG' file='schemasInternals' value='38' type='xmlSchemaValType'/>
5466
5473
    <enum name='XML_SCHEMAS_UNKNOWN' file='schemasInternals' value='0' type='xmlSchemaValType'/>
5467
5474
    <enum name='XML_SCHEMAS_USHORT' file='schemasInternals' value='40' type='xmlSchemaValType'/>
 
5475
    <enum name='XML_SCHEMATRONV_ASSERT' file='xmlerror' value='4000' type='xmlParserErrors' info='4000'/>
 
5476
    <enum name='XML_SCHEMATRONV_REPORT' file='xmlerror' value='4001' type='xmlParserErrors'/>
5468
5477
    <enum name='XML_SCHEMATRON_OUT_BUFFER' file='schematron' value='512' type='xmlSchematronValidOptions' info='output to a buffer'/>
 
5478
    <enum name='XML_SCHEMATRON_OUT_ERROR' file='schematron' value='8' type='xmlSchematronValidOptions' info='output via xmlStructuredErrorFunc'/>
5469
5479
    <enum name='XML_SCHEMATRON_OUT_FILE' file='schematron' value='256' type='xmlSchematronValidOptions' info='output to a file descriptor'/>
5470
5480
    <enum name='XML_SCHEMATRON_OUT_IO' file='schematron' value='1024' type='xmlSchematronValidOptions' info=' output to I/O mechanism'/>
5471
5481
    <enum name='XML_SCHEMATRON_OUT_QUIET' file='schematron' value='1' type='xmlSchematronValidOptions' info='quiet no report'/>
5614
5624
    <enum name='XML_TEXT_NODE' file='tree' value='3' type='xmlElementType'/>
5615
5625
    <enum name='XML_TREE_INVALID_DEC' file='xmlerror' value='1301' type='xmlParserErrors' info='1301'/>
5616
5626
    <enum name='XML_TREE_INVALID_HEX' file='xmlerror' value='1300' type='xmlParserErrors'/>
 
5627
    <enum name='XML_TREE_NOT_UTF8' file='xmlerror' value='1303' type='xmlParserErrors' info='1303'/>
5617
5628
    <enum name='XML_TREE_UNTERMINATED_ENTITY' file='xmlerror' value='1302' type='xmlParserErrors' info='1302'/>
5618
5629
    <enum name='XML_WAR_CATALOG_PI' file='xmlerror' value='93' type='xmlParserErrors' info='93'/>
5619
5630
    <enum name='XML_WAR_ENTITY_REDEFINED' file='xmlerror' value='107' type='xmlParserErrors' info='107'/>
8787
8798
      <return type='void'/>
8788
8799
    </function>
8789
8800
    <function name='xmlCleanupParser' file='parser' module='parser'>
8790
 
      <info>Cleanup function for the XML library. It tries to reclaim all parsing related global memory allocated for the library processing. It doesn&apos;t deallocate any document related memory. Calling this function should not prevent reusing the library but one should call xmlCleanupParser() only when the process has finished using the library or XML document built with it.</info>
 
8801
      <info>This function name is somewhat misleading. It does not clean up parser state, it cleans up memory allocated by the library itself. It is a cleanup function for the XML library. It tries to reclaim all related global memory allocated for the library processing. It doesn&apos;t deallocate any document related memory. One should call xmlCleanupParser() only when the process has finished using the library and all XML/HTML documents built with it. See also xmlInitParser() which has the opposite function of preparing the library for operations.</info>
8791
8802
      <return type='void'/>
8792
8803
    </function>
8793
8804
    <function name='xmlCleanupPredefinedEntities' file='entities' module='legacy'>
11724
11735
    <function name='xmlParseBalancedChunkMemoryRecover' file='parser' module='parser'>
11725
11736
      <cond>defined(LIBXML_SAX1_ENABLED)</cond>
11726
11737
      <info>Parse a well-balanced chunk of an XML document called by the parser The allowed sequence for the Well Balanced Chunk is the one defined by the content production in the XML grammar:  [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*</info>
11727
 
      <return type='int' info='0 if the chunk is well balanced, -1 in case of args problem and the parser error code otherwise  In case recover is set to 1, the nodelist will not be empty even if the parsed chunk is not well balanced.'/>
 
11738
      <return type='int' info='0 if the chunk is well balanced, -1 in case of args problem and the parser error code otherwise  In case recover is set to 1, the nodelist will not be empty even if the parsed chunk is not well balanced, assuming the parsing succeeded to some extent.'/>
11728
11739
      <arg name='doc' type='xmlDocPtr' info='the document the chunk pertains to'/>
11729
11740
      <arg name='sax' type='xmlSAXHandlerPtr' info='the SAX handler bloc (possibly NULL)'/>
11730
11741
      <arg name='user_data' type='void *' info='The user data returned on SAX callbacks (possibly NULL)'/>
12495
12506
    </function>
12496
12507
    <function name='xmlRecoverDoc' file='parser' module='parser'>
12497
12508
      <cond>defined(LIBXML_SAX1_ENABLED)</cond>
12498
 
      <info>parse an XML in-memory document and build a tree. In the case the document is not Well Formed, a tree is built anyway</info>
12499
 
      <return type='xmlDocPtr' info='the resulting document tree'/>
 
12509
      <info>parse an XML in-memory document and build a tree. In the case the document is not Well Formed, a attempt to build a tree is tried anyway</info>
 
12510
      <return type='xmlDocPtr' info='the resulting document tree or NULL in case of failure'/>
12500
12511
      <arg name='cur' type='xmlChar *' info='a pointer to an array of xmlChar'/>
12501
12512
    </function>
12502
12513
    <function name='xmlRecoverFile' file='parser' module='parser'>
12503
12514
      <cond>defined(LIBXML_SAX1_ENABLED)</cond>
12504
 
      <info>parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. In the case the document is not Well Formed, a tree is built anyway</info>
12505
 
      <return type='xmlDocPtr' info='the resulting document tree'/>
 
12515
      <info>parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. In the case the document is not Well Formed, it attempts to build a tree anyway</info>
 
12516
      <return type='xmlDocPtr' info='the resulting document tree or NULL in case of failure'/>
12506
12517
      <arg name='filename' type='const char *' info='the filename'/>
12507
12518
    </function>
12508
12519
    <function name='xmlRecoverMemory' file='parser' module='parser'>
12509
12520
      <cond>defined(LIBXML_SAX1_ENABLED)</cond>
12510
 
      <info>parse an XML in-memory block and build a tree. In the case the document is not Well Formed, a tree is built anyway</info>
12511
 
      <return type='xmlDocPtr' info='the resulting document tree'/>
 
12521
      <info>parse an XML in-memory block and build a tree. In the case the document is not Well Formed, an attempt to build a tree is tried anyway</info>
 
12522
      <return type='xmlDocPtr' info='the resulting document tree or NULL in case of error'/>
12512
12523
      <arg name='buffer' type='const char *' info='an pointer to a char array'/>
12513
12524
      <arg name='size' type='int' info='the size of the array'/>
12514
12525
    </function>
13815
13826
      <return type='xmlSchematronPtr' info='the internal XML Schematron structure built from the resource or NULL in case of error'/>
13816
13827
      <arg name='ctxt' type='xmlSchematronParserCtxtPtr' info='a schema validation context'/>
13817
13828
    </function>
 
13829
    <function name='xmlSchematronSetValidStructuredErrors' file='schematron' module='schematron'>
 
13830
      <cond>defined(LIBXML_SCHEMATRON_ENABLED)</cond>
 
13831
      <info>Set the structured error callback</info>
 
13832
      <return type='void'/>
 
13833
      <arg name='ctxt' type='xmlSchematronValidCtxtPtr' info='a Schematron validation context'/>
 
13834
      <arg name='serror' type='xmlStructuredErrorFunc' info='the structured error function'/>
 
13835
      <arg name='ctx' type='void *' info='the functions context'/>
 
13836
    </function>
13818
13837
    <function name='xmlSchematronValidateDoc' file='schematron' module='schematron'>
13819
13838
      <cond>defined(LIBXML_SCHEMATRON_ENABLED)</cond>
13820
13839
      <info>Validate a tree instance against the schematron</info>
14662
14681
    </function>
14663
14682
    <function name='xmlTextReaderNodeType' file='xmlreader' module='xmlreader'>
14664
14683
      <cond>defined(LIBXML_READER_ENABLED)</cond>
14665
 
      <info>Get the node type of the current node Reference: http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html</info>
 
14684
      <info>Get the node type of the current node Reference: http://www.gnu.org/software/dotgnu/pnetlib-doc/System/Xml/XmlNodeType.html</info>
14666
14685
      <return type='int' info='the xmlNodeType of the current node or -1 in case of error'/>
14667
14686
      <arg name='reader' type='xmlTextReaderPtr' info='the xmlTextReaderPtr used'/>
14668
14687
    </function>
14866
14885
    </function>
14867
14886
    <function name='xmlTextWriterEndDocument' file='xmlwriter' module='xmlwriter'>
14868
14887
      <cond>defined(LIBXML_WRITER_ENABLED)</cond>
14869
 
      <info>End an xml document. All open elements are closed</info>
14870
 
      <return type='int' info='the bytes written (may be 0 because of buffering) or -1 in case of error'/>
 
14888
      <info>End an xml document. All open elements are closed, and the content is flushed to the output.</info>
 
14889
      <return type='int' info='the bytes written or -1 in case of error'/>
14871
14890
      <arg name='writer' type='xmlTextWriterPtr' info='the xmlTextWriterPtr'/>
14872
14891
    </function>
14873
14892
    <function name='xmlTextWriterEndElement' file='xmlwriter' module='xmlwriter'>