php-doc-en/reference/paradox/functions/px-set-parameter.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

122 lines
3.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-set-parameter" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>px_set_parameter</refname>
<refpurpose>Sets a parameter</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>px_set_parameter</methodname>
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Sets 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>
Depending on the parameter you want to set, <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 is recoded into the targetencoding.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>inputencoding</term>
<listitem>
<para>
The encoding of the input data which is to be stored into the
database.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value of parameter to set. For inputencoding and targetencoding
this must be the name of the encoding as understood by iconv or
recode, e.g. iso-8859-1, utf-8, cp850.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.success;</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>px_get_info</function> to determine the DOS code page.</member>
</simplelist>
</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
-->