From 63f624a7086933a1095bffe2425e8255d76325d3 Mon Sep 17 00:00:00 2001 From: "Fred L. Drake, Jr." Date: Thu, 8 Aug 2002 18:54:15 +0000 Subject: [PATCH] Update the API documentation with the use of XML_Status for the XML_Parse() and XML_ParseBuffer() functions. --- expat/doc/reference.html | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/expat/doc/reference.html b/expat/doc/reference.html index 57b91360..df26de3e 100644 --- a/expat/doc/reference.html +++ b/expat/doc/reference.html @@ -646,12 +646,18 @@ functions from within an XML_ExternalEntityRefHandler, if they apply to the parser created by XML_ExternalEntityParserCreate.

-int
+XML_Status
 XML_Parse(XML_Parser p,
           const char *s,
           int len,
           int isFinal)
+
+enum XML_Status {
+  XML_STATUS_ERROR = 0,
+  XML_STATUS_OK = 1
+};
+
Parse some more of the document. The string s is a buffer containing part (or perhaps all) of the document. The number of bytes of s @@ -662,20 +668,21 @@ memory that s points at, then a memory fault is likely. The isFinal parameter informs the parser that this is the last piece of the document. Frequently, the last piece is empty (i.e. len is zero.) -If a parse error occurred, it returns 0. Otherwise it returns a non-zero -value. +If a parse error occurred, it returns XML_STATUS_ERROR. +Otherwise it returns XML_STATUS_OK value. 
-int
+XML_Status
 XML_ParseBuffer(XML_Parser p,
                 int len,
                 int isFinal)
-This is just like XML_Parse, except in this case expat provides the buffer. -By obtaining the buffer from expat with the XML_GetBuffer -function, the application can avoid double copying of the input. +This is just like XML_Parse, except in this case expat +provides the buffer. By obtaining the buffer from expat with the +XML_GetBuffer function, the application can avoid double +copying of the input.