<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli.ssl-set" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysqli::ssl_set</refname>
  <refname>mysqli_ssl_set</refname>
  <refpurpose>Used for establishing secure connections using SSL</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="mysqli">
   <modifier>public</modifier> <type>true</type><methodname>mysqli::ssl_set</methodname>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>key</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_certificate</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_path</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>cipher_algos</parameter></methodparam>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type>true</type><methodname>mysqli_ssl_set</methodname>
   <methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>key</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_certificate</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>ca_path</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>cipher_algos</parameter></methodparam>
  </methodsynopsis>
  <para>
   Used for establishing secure connections using SSL. It must be called
   before <function>mysqli_real_connect</function>. This function does
   nothing unless OpenSSL support is enabled.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysqli.link.description;
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       The path name to the key file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>certificate</parameter></term>
     <listitem>
      <para>
       The path name to the certificate file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ca_certificate</parameter></term>
     <listitem>
      <para>
       The path name to the certificate authority file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ca_path</parameter></term>
     <listitem>
      <para>
       The pathname to a directory that contains trusted SSL CA certificates
       in <acronym>PEM</acronym> format.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algos</parameter></term>
     <listitem>
      <para>
       A list of allowable ciphers to use for SSL encryption.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always; If SSL setup is
   incorrect <function>mysqli_real_connect</function> will return an error
   when you attempt to connect.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysqli_options</function></member>
    <member><function>mysqli_real_connect</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
-->
