uTools-Manuals/docs/php/fam_monitor_collection.html
2019-04-08 23:22:26 +08:00

115 lines
4.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Monitor a collection of files in a directory for changes</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.fam-monitor-collection" class="refentry">
<div class="refnamediv">
<h1 class="refname">fam_monitor_collection</h1>
<p class="verinfo">(PHP 5 &lt; 5.1.0)</p><p class="refpurpose"><span class="refname">fam_monitor_collection</span> &mdash; <span class="dc-title">Monitor a collection of files in a directory for changes</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fam-monitor-collection-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>fam_monitor_collection</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$fam</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dirname</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$depth</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$mask</code></span>
) : <span class="type">resource</span></div>
<p class="para rdfs-comment">
Requests monitoring for a collection of files within a directory.
</p>
<p class="para">
A FAM event will be generated whenever the status of the files change.
The possible event codes are described in detail in the
<a href="fam.constants.html" class="link">constants part</a> of this section.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fam-monitor-collection-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">fam</code></dt>
<dd>
<p class="para">
A resource representing a connection to the FAM service returned by
<span class="function"><a href="fam_open.html" class="function">fam_open()</a></span>
</p>
</dd>
<dt>
<code class="parameter">dirname</code></dt>
<dd>
<p class="para">
Directory path to the monitored files
</p>
</dd>
<dt>
<code class="parameter">depth</code></dt>
<dd>
<p class="para">
The maximum search <code class="parameter">depth</code> starting from this
directory
</p>
</dd>
<dt>
<code class="parameter">mask</code></dt>
<dd>
<p class="para">
A shell pattern <code class="parameter">mask</code> restricting the file names
to look for
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fam-monitor-collection-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
Returns a monitoring resource or <strong><code>FALSE</code></strong> on errors.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.fam-monitor-collection-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="fam_monitor_file.html" class="function" rel="rdfs-seeAlso">fam_monitor_file()</a> - Monitor a regular file for changes</span></li>
<li class="member"><span class="function"><a href="fam_monitor_directory.html" class="function" rel="rdfs-seeAlso">fam_monitor_directory()</a> - Monitor a directory for changes</span></li>
<li class="member"><span class="function"><a href="fam_cancel_monitor.html" class="function" rel="rdfs-seeAlso">fam_cancel_monitor()</a> - Terminate monitoring</span></li>
<li class="member"><span class="function"><a href="fam_suspend_monitor.html" class="function" rel="rdfs-seeAlso">fam_suspend_monitor()</a> - Temporarily suspend monitoring</span></li>
<li class="member"><span class="function"><a href="fam_resume_monitor.html" class="function" rel="rdfs-seeAlso">fam_resume_monitor()</a> - Resume suspended monitoring</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>