mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
107 lines
3.1 KiB
XML
107 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.fam-monitor-collection" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>fam_monitor_collection</refname>
|
|
<refpurpose>Monitor a collection of files in a directory for changes</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>fam_monitor_collection</methodname>
|
|
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>dirname</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>depth</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mask</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Requests monitoring for a collection of files within a directory.
|
|
</para>
|
|
<para>
|
|
A FAM event will be generated whenever the status of the files change.
|
|
The possible event codes are described in detail in the
|
|
<link linkend="fam.constants">constants part</link> of this section.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>fam</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A resource representing a connection to the FAM service returned by
|
|
<function>fam_open</function>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>dirname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Directory path to the monitored files
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>depth</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The maximum search <parameter>depth</parameter> starting from this
|
|
directory
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mask</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A shell pattern <parameter>mask</parameter> restricting the file names
|
|
to look for
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a monitoring resource or &false; on errors.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>fam_monitor_file</function></member>
|
|
<member><function>fam_monitor_directory</function></member>
|
|
<member><function>fam_cancel_monitor</function></member>
|
|
<member><function>fam_suspend_monitor</function></member>
|
|
<member><function>fam_resume_monitor</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
|
|
-->
|