Source of: /manual/en/function.fam-suspend-monitor.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.fam.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.fam-suspend-monitor.php',
1 => 'fam_suspend_monitor',
),
'up' =>
array (
0 => 'ref.fam.php',
1 => 'FAM Functions',
),
'prev' =>
array (
0 => 'function.fam-resume-monitor.php',
1 => 'fam_resume_monitor',
),
'next' =>
array (
0 => 'book.ftp.php',
1 => 'FTP',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.fam-suspend-monitor" class="refentry">
<div class="refnamediv">
<h1 class="refname">fam_suspend_monitor</h1>
<p class="verinfo">(PHP 5 <= 5.0.5)</p><p class="refpurpose"><span class="refname">fam_suspend_monitor</span> — <span class="dc-title">Temporarily suspend monitoring</span></p>
</div>
<a name="function.fam-suspend-monitor.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>fam_suspend_monitor</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$fam</tt></span>
, <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$fam_monitor</tt></span>
)</div>
<p class="para rdfs-comment">
<b>fam_suspend_monitor()</b> temporarily suspend monitoring
of a resource.
</p>
<p class="para">
Monitoring can later be continued using <a href="function.fam-resume-monitor.php" class="function">fam_resume_monitor()</a>
without the need of requesting a complete new monitor.
</p>
</div>
<a name="function.fam-suspend-monitor.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">fam</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A resource representing a connection to the FAM service returned by
<a href="function.fam-open.php" class="function">fam_open()</a>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">fam_monitor</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A resource returned by one of the <i>fam_monitor_XXX</i>
functions
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.fam-suspend-monitor.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.fam-suspend-monitor.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.fam-cancel-monitor.php" class="function" rel="rdfs-seeAlso">fam_cancel_monitor()</a> - Terminate monitoring</li>
<li class="member"><a href="function.fam-resume-monitor.php" class="function" rel="rdfs-seeAlso">fam_resume_monitor()</a> - Resume suspended monitoring</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
