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

Comparing projects/libstatgrab/docs/sg_get_page_stats.xml (file contents):
Revision 1.4 by tdb, Sun May 2 09:35:15 2004 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_page_stats">
6 > <refentry id="sg_get_page_stats">
7  
8    <refentryinfo>
9      <date>$Date$</date>
10      <releaseinfo>$Id$</releaseinfo>
11    </refentryinfo>
12 <  
12 >
13    <refmeta>
14 <    <refentrytitle>get_page_stats</refentrytitle>
14 >    <refentrytitle>sg_get_page_stats</refentrytitle>
15      <manvolnum>3</manvolnum>
16      <refmiscinfo>i-scream</refmiscinfo>
17    </refmeta>
18 <  
18 >
19    <refnamediv>
20 <    <refname>get_page_stats</refname>
21 <    <refname>get_page_stats_diff</refname>
20 >    <refname>sg_get_page_stats</refname>
21 >    <refname>sg_get_page_stats_diff</refname>
22      <refpurpose>get paging statistics</refpurpose>
23    </refnamediv>
24 <    
24 >
25    <refsynopsisdiv>
26      <funcsynopsis>
27        <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
28        <funcprototype>
29 <        <funcdef>page_stat_t *<function>get_page_stats</function></funcdef>
29 >        <funcdef>sg_page_stats *<function>sg_get_page_stats</function></funcdef>
30          <void/>
31        </funcprototype>
32        <funcprototype>
33 <        <funcdef>page_stat_t *<function>get_page_stats_diff</function></funcdef>
33 >        <funcdef>sg_page_stats *<function>sg_get_page_stats_diff</function></funcdef>
34          <void/>
35        </funcprototype>
36      </funcsynopsis>
37    </refsynopsisdiv>
38 <    
38 >
39    <refsect1>
40      <title>Description</title>
41      <para>
42 <      <function>get_page_stats</function> and
43 <      <function>get_page_stats_diff</function> both return a pointer to
44 <      a static buffer of type <structname>page_stat_t</structname>.
42 >      <function>sg_get_page_stats</function> and
43 >      <function>sg_get_page_stats_diff</function> both return a pointer to
44 >      a static buffer of type <structname>sg_page_stats</structname>.
45      </para>
46      <para>
47 <      <function>get_page_stats</function> will return the number of
47 >      <function>sg_get_page_stats</function> will return the number of
48        pages the system has paged in and out since bootup.
49 <      <function>get_page_stats_diff</function> will return the
49 >      <function>sg_get_page_stats_diff</function> will return the
50        difference since last time it was called.  If it has not been
51        called before, it will return
52 <      <function>get_page_stats</function>.
52 >      <function>sg_get_page_stats</function>.
53      </para>
54    </refsect1>
55 <  
55 >
56    <refsect1>
57      <title>Return Values</title>
58  
# Line 61 | Line 61 | typedef struct{
61          long long pages_pagein;
62          long long pages_pageout;
63          time_t systime;
64 < }page_stat_t;
64 > }sg_page_stats;
65      </programlisting>
66  
67      <variablelist>
# Line 120 | Line 120 | typedef struct{
120        </member>
121      </simplelist>
122    </refsect1>
123 <  
123 >
124    <refsect1>
125      <title>Website</title>
126 <    
126 >
127      <simplelist type="vert">
128        <member>
129          <ulink url="http://www.i-scream.org/libstatgrab/">

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines