php-doc-en/reference/openssl/functions/openssl-error-string.xml
Mehdi Achour f83085d47f ref.openssl: switch to new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237444 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-11 23:31:38 +00:00

69 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id="function.openssl-error-string">
<refnamediv>
<refname>openssl_error_string</refname>
<refpurpose>Return openSSL error message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>openssl_error_string</methodname>
<void/>
</methodsynopsis>
<para>
<function>openssl_error_string</function> returns the last error from the
openSSL library. Error messages are stacked, so this function should be
called multiple times to collect all of the information.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an error message string, or &false; if there are no more error
messages to return.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>openssl_error_string</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// lets assume you just called an openssl function that failed
while ($msg = openssl_error_string())
echo $msg . "<br />\n";
?>
]]>
</programlisting>
</example>
</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
-->