ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/libstatgrab/docs/sg_get_process_stats.xml
(Generate patch)

Comparing projects/libstatgrab/docs/sg_get_process_stats.xml (file contents):
Revision 1.2 by tdb, Thu Oct 2 17:38:03 2003 UTC vs.
Revision 1.5 by tdb, Sun May 2 17:21:35 2004 UTC

# Line 3 | Line 3
3   <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4                 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5  
6 < <refentry id="get_process_stats">
6 > <refentry id="sg_get_process_stats">
7  
8    <refentryinfo>
9      <date>$Date$</date>
10      <releaseinfo>$Id$</releaseinfo>
11    </refentryinfo>
12 <  
12 >
13    <refmeta>
14 <    <refentrytitle>get_process_stats</refentrytitle>
14 >    <refentrytitle>sg_get_process_stats</refentrytitle>
15      <manvolnum>3</manvolnum>
16      <refmiscinfo>i-scream</refmiscinfo>
17    </refmeta>
18 <  
18 >
19    <refnamediv>
20 <    <refname>get_process_stats</refname>
20 >    <refname>sg_get_process_count</refname>
21      <refpurpose>get process statistics</refpurpose>
22    </refnamediv>
23 <    
23 >
24    <refsynopsisdiv>
25      <funcsynopsis>
26        <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
27        <funcprototype>
28 <        <funcdef>process_stat_t *<function>get_process_stats</function></funcdef>
28 >        <funcdef>sg_process_count *<function>sg_get_process_count</function></funcdef>
29          <void/>
30        </funcprototype>
31      </funcsynopsis>
32    </refsynopsisdiv>
33 <    
33 >
34    <refsect1>
35      <title>Description</title>
36      <para>
37 <      <function>get_process_stats</function> returns a pointer to a
38 <      static buffer of type <structname>process_stat_t</structname>.
37 >      <function>sg_get_process_count</function> returns a pointer to a
38 >      static buffer of type <structname>sg_process_count</structname>.
39      </para>
40      <para>
41        It provides information on the number of processes and the
42        system and the different states they're in.
43      </para>
44    </refsect1>
45 <  
45 >
46    <refsect1>
47      <title>Return Values</title>
48  
49      <para>
50        The structure returned is of type
51 <      <structname>process_stat_t</structname>.
51 >      <structname>sg_process_count</structname>.
52      </para>
53  
54      <programlisting>
# Line 58 | Line 58 | typedef struct{
58          int sleeping;
59          int stopped;
60          int zombie;
61 < }process_stat_t;
61 > }sg_process_count;
62      </programlisting>
63  
64      <variablelist>
# Line 117 | Line 117 | typedef struct{
117        </member>
118      </simplelist>
119    </refsect1>
120 <  
120 >
121    <refsect1>
122      <title>Website</title>
123 <    
123 >
124      <simplelist type="vert">
125        <member>
126 <        <ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink>
126 >        <ulink url="http://www.i-scream.org/libstatgrab/">
127 >          http://www.i-scream.org/libstatgrab/
128 >        </ulink>
129        </member>
130      </simplelist>
131    </refsect1>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines