mysql-set-charset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mysql-set-charset" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mysql_set_charset</refname>
  <refpurpose>Sets the client character set</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_set_charset</function></member>
    <member>PDO: Add <literal>charset</literal> to the connection string, such as <literal>charset=utf8</literal></member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>mysql_set_charset</methodname>
   <methodparam><type>string</type><parameter>charset</parameter></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   Sets the default character set for the current connection.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       A valid character set name.
      </para>
     </listitem>
    </varlistentry>
    &mysql.linkid.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function requires MySQL 5.0.7 or later.
   </para>
  </note>
  <note>
   <para>
    This is the preferred way to change the charset. Using
    <function>mysql_query</function> to set it (such as <literal>SET NAMES utf8</literal>)
    is not recommended. See the <link linkend="mysqlinfo.concepts.charset">MySQL character set concepts</link>
    section for more information.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="mysqlinfo.concepts.charset">Setting character sets in MySQL</link></member>
    <member><link xlink:href="&url.mysql.charsets;">List of character sets that MySQL supports</link></member>
    <member><function>mysql_client_encoding</function></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
-->