ldap-control-paged-result-response.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e706a6b5578e9d0a9d1a101eeb654124db97e0ed Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id='function.ldap-control-paged-result-response'
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ldap_control_paged_result_response</refname>
  <refpurpose>LDAP ページネーションクッキーを取得する</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
   &ldap.warn.control-paged;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ldap_control_paged_result_response</methodname>
   <methodparam><type>resource</type><parameter>link</parameter></methodparam>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">cookie</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">estimated</parameter></methodparam>
  </methodsynopsis>
  <para>
   サーバーから送られるページネーション情報を取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>link</parameter></term>
     <listitem>
      <para>
       <function>ldap_connect</function> が返す LDAP リソース。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cookie</parameter></term>
     <listitem>
      <para>
       サーバーから送られる opaque structure。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>estimated</parameter></term>
     <listitem>
      <para>
       取得するエントリ数の予測。
      </para>
     </listitem>
    </varlistentry>
    </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        この関数は削除されました。
       </entry>
      </row>
      <row>
       <entry>7.4.0</entry>
       <entry>
        この関数は非推奨になりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ldap_control_paged_result</function></member>
    <member><link xlink:href="&url.rfc;2696">RFC2696 : LDAP Control Extension for Simple
    Paged Results Manipulation</link></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
-->