delete.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c6b1157e3a7d906f3fa0f2836ff52aa2786806fa Maintainer: takagi Status: ready -->
<refentry xml:id="memcache.delete" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Memcache::delete</refname>
  <refpurpose>サーバーから項目を削除する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>Memcache::delete</methodname>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>exptime</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>

  <para>
   <function>Memcache::delete</function> は、
   <parameter>key</parameter> に対応する項目を削除します。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       削除したい項目のキー。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>exptime</parameter></term>
     <listitem>
      <para>
       この非推奨のパラメータはサポートしておらず、デフォルトで <literal>0</literal> 秒になっています。
       このパラメータを使ってはいけません。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>PECL memcache 3.0.5</entry>
      <entry>
       <parameter>exptime</parameter> パラメータは、推奨されなくなりました。
       かつ、この値を指定すべきではありません。
       を使うことは推奨しません。
       <literal>0</literal> 以外の値を設定すると、予期しないエラーが起こる可能性があります。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>Memcache::delete</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

/* 手続き型の API */
$memcache_obj = memcache_connect('memcache_host', 11211);

/* 項目をサーバーから削除します */
memcache_delete($memcache_obj, 'key_to_delete');

/* オブジェクト指向の API */
$memcache_obj = new Memcache;
$memcache_obj->connect('memcache_host', 11211);

$memcache_obj->delete('key_to_delete');

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Memcache::set</function></member>
    <member><function>Memcache::replace</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
-->