xattr-supported.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: takagi Status: ready -->
<refentry xml:id="function.xattr-supported" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xattr_supported</refname>
  <refpurpose>
   ファイルシステムが拡張属性をサポートしているかどうかを調べる
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xattr_supported</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   この関数は、指定したファイルを保持するファイルシステムが
   拡張属性をサポートしているかどうかを調べます。ファイルに対する
   読み込みアクセス権限が必要です。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       調べるファイルのパス。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <table>
        <title>サポートされる xattr のフラグ</title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>XATTR_DONTFOLLOW</constant></entry>
           <entry>シンボリックリンクのリンク先をたどらず、リンクそのものを操作します。</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   この関数は、ファイルシステムが拡張属性をサポートしている場合に &true;、
   していない場合に &false;、そして判断できない場合 (たとえばパスが
   間違っていたりファイルへのアクセス権限がない場合) には &null;
   を返します。
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>xattr_supported</function> の例</title>
    <para>
     以下のコードは、拡張属性が使用可能かどうかを調べます。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$file = 'some_file';

if (xattr_supported($file)) {
    /* ... xattr_* 関数が使用できます ... */
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xattr_get</function></member>
    <member><function>xattr_list</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
-->