xattr-set.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.xattr-set" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xattr_set</refname>
  <refpurpose>
   Définit un attribut étendu
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xattr_set</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>string</type><parameter>value</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>xattr_set</function> définie la valeur d'un attribut étendu nommé
   <parameter>name</parameter> à la valeur <parameter>value</parameter>
   d'un fichier désigné par le paramètre <parameter>path</parameter>.
  </para>
  &xattr.namespace;
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Le fichier dans lequel nous devons définir l'attribut.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Le nom de l'attribut étendu. Cet attribut sera créé s'il n'existe pas encore ou
       remplacé sinon. Vous pouvez modifier ce comportement en utilisant
       le paramètre <parameter>flags</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       La valeur de l'attribut.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Flags xattr supportés</title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>XATTR_CREATE</constant></entry>
           <entry>La fonction échouera si l'attribut étendu existe déjà.</entry>
          </row>
          <row>
           <entry><constant>XATTR_REPLACE</constant></entry>
           <entry>La fonction échouera si l'attribut étendu n'existe pas.</entry>
          </row>
          <row>
           <entry><constant>XATTR_DONTFOLLOW</constant></entry>
           <entry>Ne pas suivre les liens symboliques mais opère directement sur le lien
           lui-même.</entry>
          </row>
          <row>
           <entry><constant>XATTR_ROOT</constant></entry>
           <entry>Définie l'attribut dans l'espace de noms racine. Nécessaire
           les privilèges d'administrateur.</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Définition des attributs étendus dans un fichier <filename>.wav</filename></title>
    <programlisting role="php">
<![CDATA[
<?php
$file = 'ma_chanson_favorite.wav';
xattr_set($file, 'Artist', 'Someone');
xattr_set($file, 'My ranking', 'Good');
xattr_set($file, 'Listen count', '34');

/* ... autres codes ... */

printf("Vous avez écouté cette chanson %d fois", xattr_get($file, 'Listen count'));
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xattr_get</function></member>
    <member><function>xattr_remove</function></member>
   </simplelist>
  </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:"~/.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
-->