curl-reset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b7f8c11e56ff1c57a2993e2ed7e5c5ace18637fd Maintainer: takagi Status: ready -->

<refentry xml:id="function.curl-reset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>curl_reset</refname>
  <refpurpose>libcurl セッションハンドルのすべてのオプションをリセットする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>curl_reset</methodname>
   <methodparam><type>CurlHandle</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定した cURL ハンドルに設定されているすべてのオプションを初期化してデフォルト値に戻します。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   &curl.ch.description;
  </variablelist>
 </refsect1>

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

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &curl.changelog.handle-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>curl_reset</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// curl ハンドルを作ります
$ch = curl_init();

// CURLOPT_USERAGENT オプションを設定します
curl_setopt($ch, CURLOPT_USERAGENT, "My test user-agent");

// これまでに設定されたすべてのオプションを初期化します
curl_reset($ch);

// HTTP リクエストを送信します
curl_setopt($ch, CURLOPT_URL, 'http://example.com/');
curl_exec($ch); // 事前に設定した user-agent は送信されません。curl_reset で初期化されたからです

// ハンドルを閉じます
curl_close($ch);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>curl_reset</function> は、<function>curl_init</function> のパラメータで指定した URL も初期化します。
   </para>
  </note>
 </refsect1>

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