<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Fetches the current row from a result set as an array</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlite-create-function.html">sqlite_create_function</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlite-error-string.html">sqlite_error_string</a></div>
<div class="up"><a href="ref.sqlite.html">SQLite Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.sqlite-current" class="refentry">
<div class="refnamediv">
<h1 class="refname">sqlite_current</h1>
<h1 class="refname">SQLiteResult::current</h1>
<h1 class="refname">SQLiteUnbuffered::current</h1>
<p class="verinfo">(PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)</p><p class="refpurpose"><span class="refname">sqlite_current</span> -- <span class="refname">SQLiteResult::current</span> -- <span class="refname">SQLiteUnbuffered::current</span> — <span class="dc-title">Fetches the current row from a result set as an array</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.sqlite-current-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>sqlite_current</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$result_type</code><span class="initializer"> = SQLITE_BOTH</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$decode_binary</code><span class="initializer"> = true</span></span>
]] )</div>
<p class="para rdfs-comment">Object oriented style (method):</p>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>SQLiteResult::current</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$result_type</code><span class="initializer"> = SQLITE_BOTH</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$decode_binary</code><span class="initializer"> = true</span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>SQLiteUnbuffered::current</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$result_type</code><span class="initializer"> = SQLITE_BOTH</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$decode_binary</code><span class="initializer"> = true</span></span>
]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>sqlite_current()</strong></span> is identical to
<span class="function"><a href="function.sqlite-fetch-array.html" class="function">sqlite_fetch_array()</a></span> except that it does not advance
to the next row prior to returning the data; it returns the data from the
current position only.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.sqlite-current-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">result</code></em></span>
<dd>
<p class="para">
The SQLite result resource. This parameter is not required when using
the object-oriented method.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">result_type</code></em></span>
<dd>
<p class="para">The optional <em><code class="parameter">result_type</code></em>
parameter accepts a constant and determines how the returned array will be
indexed. Using <strong><code>SQLITE_ASSOC</code></strong> will return only associative
indices (named fields) while <strong><code>SQLITE_NUM</code></strong> will return
only numerical indices (ordinal field numbers). <strong><code>SQLITE_BOTH</code></strong>
will return both associative and numerical indices.
<strong><code>SQLITE_BOTH</code></strong> is the default for this function.</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">decode_binary</code></em></span>
<dd>
<p class="para">When the <em><code class="parameter">decode_binary</code></em>
parameter is set to <strong><code>TRUE</code></strong> (the default), PHP will decode the binary encoding
it applied to the data if it was encoded using the
<span class="function"><a href="function.sqlite-escape-string.html" class="function">sqlite_escape_string()</a></span>. You should normally leave this
value at its default, unless you are interoperating with databases created by
other sqlite capable applications.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.sqlite-current-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of the current row from a result set; <strong><code>FALSE</code></strong> if the
current position is beyond the final row.
</p>
<p class="para">The column names returned by
<strong><code>SQLITE_ASSOC</code></strong> and <strong><code>SQLITE_BOTH</code></strong> will be
case-folded according to the value of the
<a href="sqlite.configuration.html#ini.sqlite.assoc-case" class="link">sqlite.assoc_case</a> configuration
option.</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.sqlite-current-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.sqlite-seek.html" class="function" rel="rdfs-seeAlso">sqlite_seek()</a> - Seek to a particular row number of a buffered result set</span></li>
<li class="member"> <span class="function"><a href="function.sqlite-next.html" class="function" rel="rdfs-seeAlso">sqlite_next()</a> - Seek to the next row number</span></li>
<li class="member"> <span class="function"><a href="function.sqlite-fetch-array.html" class="function" rel="rdfs-seeAlso">sqlite_fetch_array()</a> - Fetches the next row from a result set as an array</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.sqlite-create-function.html">sqlite_create_function</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.sqlite-error-string.html">sqlite_error_string</a></div>
<div class="up"><a href="ref.sqlite.html">SQLite Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
