php-doc-en/reference/win32ps/functions/win32-ps-stat-proc.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

115 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.win32-ps-stat-proc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>win32_ps_stat_proc</refname>
<refpurpose>Stat process</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>win32_ps_stat_proc</methodname>
<methodparam choice="opt"><type>int</type><parameter>pid</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Retrieves statistics about the process with the process id <parameter>pid</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<para>
The process id of the process to stat. If omitted, the id of the current process.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &false; on failure, or an array consisting of the
following information on success:
</para>
<para>
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<para>
The process id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>exe</parameter></term>
<listitem>
<para>
The path to the executable image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mem</parameter></term>
<listitem>
<para>
An array containing information about the following memory utilization indicators:
<parameter>page_fault_count</parameter>,
<parameter>peak_working_set_size</parameter>,
<parameter>working_set_size</parameter>,
<parameter>quota_peak_paged_pool_usage</parameter>,
<parameter>quota_paged_pool_usage</parameter>,
<parameter>quota_peak_non_paged_pool_usage</parameter>,
<parameter>quota_non_paged_pool_usage</parameter>,
<parameter>pagefile_usage</parameter> and
<parameter>peak_pagefile_usage</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tms</parameter></term>
<listitem>
<para>
An array containing information about the following CPU time utilization indicators:
<parameter>created</parameter>, <parameter>kernel</parameter> and <parameter>user</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>win32_ps_list_procs</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
-->