<!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>Gets a parameter</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.px-get-info.html">px_get_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.px-get-record.html">px_get_record</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-get-parameter" class="refentry">
<div class="refnamediv">
<h1 class="refname">px_get_parameter</h1>
<p class="verinfo">(PECL paradox >= 1.1.0)</p><p class="refpurpose"><span class="refname">px_get_parameter</span> — <span class="dc-title">Gets a parameter</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.px-get-parameter-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>px_get_parameter</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$pxdoc</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
)</div>
<p class="para rdfs-comment">
Gets various parameters.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.px-get-parameter-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">name</code></em></span>
<dd>
<p class="para">
The <em><code class="parameter">name</code></em> can be one of the following:
</p>
<dl>
<dt>
<span class="term">tablename</span>
<dd>
<p class="para">
The name of the table as it will be stored in the database header.
</p>
</dd>
</dt>
<dt>
<span class="term">targetencoding</span>
<dd>
<p class="para">
The encoding for the output. Data which is being read from character
fields with <span class="function"><a href="function.px-get-record.html" class="function">px_get_record()</a></span> or
<span class="function"><a href="function.px-retrieve-record.html" class="function">px_retrieve_record()</a></span> is recoded into the
targetencoding. If it is not set, then the data
will be delivered as stored in the database file.
</p>
</dd>
</dt>
<dt>
<span class="term">inputencoding</span>
<dd>
<p class="para">
The encoding of the input data which is to be stored into the database.
When storing data of character fields in the database, the data is
expected to be delivered in this encoding.
</p>
</dd>
</dt>
</dl>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.px-get-parameter-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value of the parameter or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.px-get-info.html">px_get_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.px-get-record.html">px_get_record</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>
