mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
a00edd14b7
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@164407 c90b9560-bf6c-de11-be94-00142212c4b1
86 lines
3.4 KiB
XML
86 lines
3.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.4 $ -->
|
|
<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>object</type><parameter>link</parameter></methodparam>
|
|
<methodparam choice='opt'><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice='opt'><type>string</type><parameter>cert</parameter></methodparam>
|
|
<methodparam choice='opt'><type>string</type><parameter>ca</parameter></methodparam>
|
|
<methodparam choice='opt'><type>string</type><parameter>capath</parameter></methodparam>
|
|
<methodparam choice='opt'><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 choice='opt'><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice='opt'><type>string</type><parameter>cert</parameter></methodparam>
|
|
<methodparam choice='opt'><type>string</type><parameter>ca</parameter></methodparam>
|
|
<methodparam choice='opt'><type>string</type><parameter>capath</parameter></methodparam>
|
|
<methodparam choice='opt'><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>
|
|
<title>Return values</title>
|
|
<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>
|
|
<title>See also</title>
|
|
<para>
|
|
<function>mysqli_options</function>,
|
|
<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
|
|
-->
|