mirror of
https://github.com/macintoshplus/doc-en.git
synced 2026-03-24 17:02:07 +01:00
71 lines
2.2 KiB
XML
71 lines
2.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="splpriorityqueue.setextractflags" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>SplPriorityQueue::setExtractFlags</refname>
|
|
<refpurpose>Sets the mode of extraction</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="SplPriorityQueue">
|
|
<modifier>public</modifier> <type>int</type><methodname>SplPriorityQueue::setExtractFlags</methodname>
|
|
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Defines what is extracted by <methodname>SplPriorityQueue::current</methodname>,
|
|
<methodname>SplPriorityQueue::top</methodname> and
|
|
<methodname>SplPriorityQueue::extract</methodname>.
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem><simpara><constant>SplPriorityQueue::EXTR_DATA</constant> (0x00000001): Extract the data</simpara></listitem>
|
|
<listitem><simpara><constant>SplPriorityQueue::EXTR_PRIORITY</constant> (0x00000002): Extract the priority</simpara></listitem>
|
|
<listitem><simpara><constant>SplPriorityQueue::EXTR_BOTH</constant> (0x00000003): Extract an array containing both</simpara></listitem>
|
|
</itemizedlist>
|
|
<para>
|
|
The default mode is <constant>SplPriorityQueue::EXTR_DATA</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the flags of extraction.
|
|
</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
|
|
-->
|