<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
  <refentry id="function.mysqli-ssl-set">
   <refnamediv>
    <refname>mysqli_ssl_set</refname>
    <refname>mysqli->ssl_set</refname>
    <refpurpose>Used for establishing secure connections using SSL</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style:</para>
    <methodsynopsis>
     <type>bool</type><methodname>mysqli_ssl_set</methodname>
     <methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
     <methodparam><type>string</type><parameter>key</parameter></methodparam>
     <methodparam><type>string</type><parameter>cert</parameter></methodparam>
     <methodparam><type>string</type><parameter>ca</parameter></methodparam>
     <methodparam><type>string</type><parameter>capath</parameter></methodparam>
     <methodparam><type>string</type><parameter>cipher</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (method):</para>
    <classsynopsis>
     <ooclass><classname>mysqli</classname></ooclass>
     <methodsynopsis>
      <type>bool</type><methodname>ssl_set</methodname>
      <methodparam><type>string</type><parameter>key</parameter></methodparam>
      <methodparam><type>string</type><parameter>cert</parameter></methodparam>
      <methodparam><type>string</type><parameter>ca</parameter></methodparam>
      <methodparam><type>string</type><parameter>capath</parameter></methodparam>
      <methodparam><type>string</type><parameter>cipher</parameter></methodparam>
     </methodsynopsis>
    </classsynopsis>
    <para>
     The function <function>mysqli_ssl_set</function> is 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>
    <para>
     <parameter>key</parameter> is the pathname to the key file.
     <parameter>cert</parameter> is the pathname to the certificate file.
     <parameter>ca</parameter> is the pathname to the certificate authority file.
     <parameter>capath</parameter> is the pathname to a directory that contains
     trusted SSL CA certificates in pem format.
     <parameter>cipher</parameter> is a list of allowable ciphers to use for
     SSL encryption.
     Any unused SSL parameters may be given as &null;
    </para>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
      This function always returns &true; value. If SSL setup is
      incorrect <function>mysqli_real_connect</function> will return an error
      when you attempt to connect.
    </para>
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <para>
     <function>mysqli_options</function>&listendand;
     <function>mysqli_real_connect</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
-->