Source of: /manual/en/function.xml-get-current-byte-index.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.xml.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.xml-get-current-byte-index.php',
1 => 'xml_get_current_byte_index',
),
'up' =>
array (
0 => 'ref.xml.php',
1 => 'XML Parser Functions',
),
'prev' =>
array (
0 => 'function.xml-error-string.php',
1 => 'xml_error_string',
),
'next' =>
array (
0 => 'function.xml-get-current-column-number.php',
1 => 'xml_get_current_column_number',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.xml-get-current-byte-index" class="refentry">
<div class="refnamediv">
<h1 class="refname">xml_get_current_byte_index</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">xml_get_current_byte_index</span> — <span class="dc-title">Get current byte index for an XML parser</span></p>
</div>
<a name="function.xml-get-current-byte-index.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>xml_get_current_byte_index</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$parser</tt></span>
)</div>
<p class="para rdfs-comment">
Gets the current byte index of the given XML parser.
</p>
</div>
<a name="function.xml-get-current-byte-index.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">parser</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A reference to the XML parser to get byte index from.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.xml-get-current-byte-index.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function returns <b><tt class="constant">FALSE</tt></b> if <i><tt class="parameter">parser</tt></i>
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).
</p>
</div>
<a name="function.xml-get-current-byte-index.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<div class="warning"><b class="warning">Warning</b>
<p class="para">
This function returns byte index according to UTF-8 encoded text
disregarding if input is in another encoding.
</p>
</div>
</div>
<a name="function.xml-get-current-byte-index.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.xml-get-current-column-number.php" class="function" rel="rdfs-seeAlso">xml_get_current_column_number()</a> - Get current column number for an XML parser</li>
<li class="member"><a href="function.xml-get-current-line-number.php" class="function" rel="rdfs-seeAlso">xml_get_current_line_number()</a> - Get current line number for an XML parser</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
