reference/xml/functions/xml-get-current-byte-index.xml
5dc10a2e575a7e84cda0e2789432cd97d674bb3f
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.xml-get-current-byte-index">
3
+
<refentry xml:id="function.xml-get-current-byte-index" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>xml_get_current_byte_index</refname>
6
6
<refpurpose>Get current byte index for an XML parser</refpurpose>
...
...
@@ -10,7 +10,7 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>int</type><methodname>xml_get_current_byte_index</methodname>
13
-
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
13
+
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
Gets the current byte index of the given XML parser.
...
...
@@ -36,12 +36,28 @@
36
36
<refsect1 role="returnvalues">
37
37
&reftitle.returnvalues;
38
38
<para>
39
-
This function returns &false; if <parameter>parser</parameter> does
40
-
not refer to a valid parser, or else it returns which byte index
39
+
Returns which byte index
41
40
the parser is currently at in its data buffer (starting at 0).
42
41
</para>
43
42
</refsect1>
44
43

44
+
<refsect1 role="changelog">
45
+
&reftitle.changelog;
46
+
<informaltable>
47
+
<tgroup cols="2">
48
+
<thead>
49
+
<row>
50
+
<entry>&Version;</entry>
51
+
<entry>&Description;</entry>
52
+
</row>
53
+
</thead>
54
+
<tbody>
55
+
&xml.changelog.parser-param;
56
+
</tbody>
57
+
</tgroup>
58
+
</informaltable>
59
+
</refsect1>
60
+

45
61
<refsect1 role="notes">
46
62
&reftitle.notes;
47
63
<warning>
...
...
@@ -63,7 +79,6 @@
63
79
</refsect1>
64
80

65
81
</refentry>
66
-

67
82
<!-- Keep this comment at the end of the file
68
83
Local variables:
69
84
mode: sgml
70
85