<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="regexiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>RegexIterator::setFlags</refname>

<refpurpose>フラグを設定する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="RegexIterator">

<modifier>public</modifier> <type>void</type><methodname>RegexIterator::setFlags</methodname>

<methodparam><type>int</type><parameter>flags</parameter></methodparam>

</methodsynopsis>

<para>

フラグを設定します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

設定するフラグ。クラス定数のビットマスクで指定します。

</para>

<para>

利用できるフラグは次のとおりです。これらのフラグの実際の意味については

<link linkend="regexiterator.constants">定義済みの定数</link>

で説明します。

<table>

<title><classname>RegexIterator</classname> のフラグ</title>

<tgroup cols="2">

<thead>

<row>

<entry>値</entry>

<entry>定数</entry>

</row>

</thead>

<tbody>

<row>

<entry>1</entry>

<entry>

<link linkend="regexiterator.constants.use-key">RegexIterator::USE_KEY</link>

</entry>

</row>

</tbody>

</tgroup>

</table>

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.void;

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example xml:id="regexiterator.setflags.example.basic">

<title><methodname>RegexIterator::setFlags</methodname> の例</title>

<para>

新しい RegexIterator を作成します。これは、キーが '<literal>test</literal>'

ではじまるすべてのエントリを取り出します。

</para>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><methodname>RegexIterator::getFlags</methodname></member>

</simplelist>

</para>

</refsect1>

</refentry>