renameindex.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 476ab39857fb032076f280fa5397ed483bf7e28d Maintainer: sammywg Status: ready -->
<refentry xml:id="ziparchive.renameindex" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::renameIndex</refname>
  <refpurpose>Benennt einen durch seinen Index bestimmten Eintrag um</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ZipArchive">
   <modifier>public</modifier> <type>bool</type><methodname>ZipArchive::renameIndex</methodname>
   <methodparam><type>int</type><parameter>index</parameter></methodparam>
   <methodparam><type>string</type><parameter>new_name</parameter></methodparam>
  </methodsynopsis>
  <para>
   Benennt einen durch seinen Index bestimmten Eintrag um.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>index</parameter></term>
     <listitem>
      <para>
       Index des umzubenennenden Eintrags.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new-name</parameter></term>
     <listitem>
      <para>
       Neuer Name.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Einen Eintrag umbenennen</title>
   <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip');
if ($res === TRUE) {
    $zip->renameIndex(2,'neuer_name.txt');
    $zip->close();
} else {
    echo 'Fehler, Code:' . $res;
}
?>
]]>
   </programlisting>
  </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
-->