Source of: /manual/en/function.apd-set-pprof-trace.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.apd.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.apd-set-pprof-trace.php',
1 => 'apd_set_pprof_trace',
),
'up' =>
array (
0 => 'ref.apd.php',
1 => 'APD Functions',
),
'prev' =>
array (
0 => 'function.apd-get-active-symbols.php',
1 => 'apd_get_active_symbols',
),
'next' =>
array (
0 => 'function.apd-set-session-trace-socket.php',
1 => 'apd_set_session_trace_socket',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.apd-set-pprof-trace" class="refentry">
<div class="refnamediv">
<h1 class="refname">apd_set_pprof_trace</h1>
<p class="verinfo">(PECL apd >= 0.2)</p><p class="refpurpose"><span class="refname">apd_set_pprof_trace</span> — <span class="dc-title">Starts the session debugging</span></p>
</div>
<a name="function.apd-set-pprof-trace.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>apd_set_pprof_trace</b></span>
([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$dump_directory</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fragment</tt><span class="initializer"> = "pprof"</span></span>
]] )</div>
<p class="para rdfs-comment">
Starts debugging to <var class="filename">pprof_{process_id}</var> in the
dump directory.
</p>
</div>
<a name="function.apd-set-pprof-trace.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">dump_directory</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The directory in which the profile dump file is written. If not set,
the <span class="option">apd.dumpdir</span> setting from the <var class="filename">php.ini</var> file is used.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">fragment</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.apd-set-pprof-trace.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns path of the destination file.
</p>
</div>
<a name="function.apd-set-pprof-trace.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>apd_set_pprof_trace()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />apd_set_pprof_trace</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.apd-set-pprof-trace.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.apd-set-session-trace.php" class="function" rel="rdfs-seeAlso">apd_set_session_trace()</a> - Starts the session debugging</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
