diff options
author | fdrake <fdrake> | 2003-03-13 02:13:06 +0000 |
---|---|---|
committer | fdrake <fdrake> | 2003-03-13 02:13:06 +0000 |
commit | 7d4014739698f9f149b6685cd83d908822d3b191 (patch) | |
tree | 6c22464b17e9c46b5b5ba159010ea05a9dfcaa12 /doc | |
parent | 9008499a640126befd97d3c314dba75ffb254577 (diff) | |
download | libexpat-7d4014739698f9f149b6685cd83d908822d3b191.tar.gz |
- better explain the XML_GetCurrent*() functions (SF bug #683681)
- fix spelling
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference.html | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/reference.html b/doc/reference.html index c532abd..4156ce1 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -1442,11 +1442,15 @@ error.</p> <p>These are the functions you'll want to call when the parse functions return <code>XML_STATUS_ERROR</code> (a parse error has -ocurred), although the position reporting functions are useful outside +occurred), although the position reporting functions are useful outside of errors. The position reported is the byte position (in the original document or entity encoding) of the first of the sequence of characters that generated the current event (or the error that caused -the parse functions to return <code>XML_STATUS_ERROR</code>.)</p> +the parse functions to return <code>XML_STATUS_ERROR</code>.) The +exceptions are callbacks trigged by declarations in the document +prologue, in which case they exact position reported is somewhere in the +relevant markup, but not necessarily as meaningful as for other +events.</p> <p>The position reporting functions are accurate only outside of the DTD. In other words, they usually return bogus information when @@ -1475,7 +1479,10 @@ long XML_GetCurrentByteIndex(XML_Parser p); </pre> <div class="fcndef"> -Return the byte offset of the position. +Return the byte offset of the position. This always corresponds to +the values returned by <code><a href= "#XML_GetCurrentLineNumber" +>XML_GetCurrentLineNumber</a></code> and <code><a href= +"#XML_GetCurrentColumnNumber" >XML_GetCurrentColumnNumber</a></code>. </div> <pre class="fcndec" id="XML_GetCurrentLineNumber"> @@ -1483,7 +1490,8 @@ int XML_GetCurrentLineNumber(XML_Parser p); </pre> <div class="fcndef"> -Return the line number of the position. +Return the line number of the position. The first line is reported as +<code>1</code>. </div> <pre class="fcndec" id="XML_GetCurrentColumnNumber"> |