php-doc-en/reference/paradox/functions/px-set-targetencoding.xml
Philip Olson 009395cfbc Miscellaneous formatting as per our guidelines:
Ex: windows->Windows, commandline->command line, webserver->web server
# Sorry translators, but it needed to be done


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229834 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-15 09:24:37 +00:00

98 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-set-targetencoding">
<refnamediv>
<refname>px_set_targetencoding</refname>
<refpurpose>Sets the encoding for character fields (deprecated)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>px_set_targetencoding</methodname>
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Set the encoding for data retrieved from a character field. All character
fields will be recoded to the encoding set by this function. If the
encoding is not set, the character data will be returned in the DOS code
page encoding as specified in the database file. The
<parameter>encoding</parameter> can be any string identifier known to
iconv or recode. On Unix systems run <literal>iconv -l</literal> for
a list of available encodings.
</para>
<para>This function is deprecated and should be replaced by calling
<function>px_set_parameter</function>.
</para>
<para>
See also <function>px_get_info</function> to determine the DOS code page
as stored in the database file.
</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>encoding</parameter></term>
<listitem>
<para>
The encoding for the output. Data which is being read from
character fields is recoded into the targetencoding.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &false; if the encoding could not be set, e.g. the encoding is
unknown, or pxlib does not support recoding at all. In the second case a
warning will be issued.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>px_set_parameter</function>
</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:"../../../../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
-->