svn: /phpdoc/en/trunk/reference/openssl/ functions/openssl-cipher-iv-length.xml versions.xml
| From: | Philip Olson | Date: | Mon, 02 May 2011 21:25:27 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/openssl/ functions/openssl-cipher-iv-length.xml versions.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-8049@lists.php.net to get a copy of this message | ||
philip Mon, 02 May 2011 21:25:27 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=310715
Log:
Documented openssl_cipher_iv_length()
Changed paths:
A phpdoc/en/trunk/reference/openssl/functions/openssl-cipher-iv-length.xml
U phpdoc/en/trunk/reference/openssl/versions.xml
Added: phpdoc/en/trunk/reference/openssl/functions/openssl-cipher-iv-length.xml
===================================================================
--- phpdoc/en/trunk/reference/openssl/functions/openssl-cipher-iv-length.xml
(rev 0)
+++ phpdoc/en/trunk/reference/openssl/functions/openssl-cipher-iv-length.xml 2011-05-02 21:25:27 UTC
(rev 310715)
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.openssl-cipher-iv-length" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>openssl_cipher_iv_length</refname>
+ <refpurpose>Gets the cipher iv length</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>integer</type><methodname>openssl_cipher_iv_length</methodname>
+
<methodparam><type>string</type><parameter>method</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Gets the cipher iv length.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>method</parameter></term>
+ <listitem>
+ <para>
+ The method.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the cipher length on success, or &false; on failure.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Emits an <constant>E_WARNING</constant> level error when the cipher algorithm
+ is unknown.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example xml:id="openssl-cipher-iv-length.example.basic">
+ <title><function>openssl_cipher_iv_length</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$method = 'AES-128-CBC';
+$ivlen = openssl_cipher_iv_length($method);
+
+echo $ivlen;
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+16
+]]>
+ </screen>
+ </example>
+ </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
+-->
Property changes on: phpdoc/en/trunk/reference/openssl/functions/openssl-cipher-iv-length.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/openssl/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/openssl/versions.xml 2011-05-02 20:12:16 UTC (rev 310714)
+++ phpdoc/en/trunk/reference/openssl/versions.xml 2011-05-02 21:25:27 UTC (rev 310715)
@@ -4,6 +4,7 @@
Do NOT translate this file
-->
<versions>
+ <function name='openssl_cipher_iv_length' from='PHP 5 >= PHP
5.3.3'/>
<function name='openssl_csr_export' from='PHP 4 >= 4.2.0, PHP
5'/>
<function name='openssl_csr_export_to_file' from='PHP 4 >= 4.2.0, PHP
5'/>
<function name='openssl_csr_get_public_key' from='PHP 5 >=
5.2.0'/>