php-doc-en/reference/xml/functions/xml-get-current-byte-index.xml
2002-04-19 11:11:21 +00:00

54 lines
1.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
<refentry id="function.xml-get-current-byte-index">
<refnamediv>
<refname>xml_get_current_byte_index</refname>
<refpurpose>get current byte index for an XML parser</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>xml_get_current_byte_index</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
</methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<simpara>
A reference to the XML parser to get byte index from.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
This function returns &false; if <parameter>parser</parameter> does
not refer to a valid parser, or else it returns which byte index
the parser is currently at in its data buffer (starting at 0).
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->