mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 12:28:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
107 lines
3 KiB
XML
107 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
|
|
<refentry xml:id="function.px-get-parameter" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>px_get_parameter</refname>
|
|
<refpurpose>Gets a parameter</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>px_get_parameter</methodname>
|
|
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets various parameters.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pxdoc</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Resource identifier of the paradox database
|
|
as returned by <function>px_new</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>name</parameter> can be one of the following:
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>tablename</term>
|
|
<listitem>
|
|
<para>
|
|
The name of the table as it will be stored in the database header.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>targetencoding</term>
|
|
<listitem>
|
|
<para>
|
|
The encoding for the output. Data which is being read from character
|
|
fields with <function>px_get_record</function> or
|
|
<function>px_retrieve_record</function> is recoded into the
|
|
targetencoding. If it is not set, then the data
|
|
will be delivered as stored in the database file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>inputencoding</term>
|
|
<listitem>
|
|
<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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the value of the parameter&return.falseforfailure;.
|
|
</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:"~/.phpdoc/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
|
|
-->
|