<!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>Returns record of paradox database</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.px-put-record.html">px_put_record</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.px-set-blob-file.html">px_set_blob_file</a></div>
<div class="up"><a href="ref.paradox.html">Paradox Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.px-retrieve-record" class="refentry">
<div class="refnamediv">
<h1 class="refname">px_retrieve_record</h1>
<p class="verinfo">(PECL paradox >= 1.4.0)</p><p class="refpurpose"><span class="refname">px_retrieve_record</span> — <span class="dc-title">Returns record of paradox database</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.px-retrieve-record-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>px_retrieve_record</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$pxdoc</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$num</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
This function is very similar to <span class="function"><a href="function.px-get-record.html" class="function">px_get_record()</a></span>
but uses internally a different approach to retrieve the data. It
relies on pxlib for reading each single field value, which usually
results in support for more field types.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function is only available if pxlib >= 0.6.0 is used.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.px-retrieve-record-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">pxdoc</code></em></span>
<dd>
<p class="para">
Resource identifier of the paradox database
as returned by <span class="function"><a href="function.px-new.html" class="function">px_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">num</code></em></span>
<dd>
<p class="para">
The record number is an artificial number counting records in the order
as they are stored in the database. The first record has number 0.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The optional <em><code class="parameter">mode</code></em> can be
<strong><code>PX_KEYTOLOWER</code></strong> or <strong><code>PX_KEYTOUPPER</code></strong>
in order to convert the keys into lower or upper case. If
<em><code class="parameter">mode</code></em> is not passed or is 0, then the key will be
exactly like the field name. The element values will contain the field
values. NULL values will be retained and are different from 0.0, 0 or
the empty string. Fields of type <strong><code>PX_FIELD_TIME</code></strong>
will be returned as an integer counting the number of milliseconds
starting at midnight. A timestamp is a floating point value also
counting milliseconds starting at the beginning of julian calendar.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.px-retrieve-record-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the <em><code class="parameter">num</code></em>'th record from the paradox
database. The record is returned as an associated array with its keys
being the field names.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.px-retrieve-record-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.px-get-record.html" class="function" rel="rdfs-seeAlso">px_get_record()</a> - Returns record of paradox database</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.px-put-record.html">px_put_record</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.px-set-blob-file.html">px_set_blob_file</a></div>
<div class="up"><a href="ref.paradox.html">Paradox Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
