libstatgrab/docs/get_user_stats.xml

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="get_user_stats">

  <refentryinfo>
    <date>$Date: 2004/03/11 17:35:24 $</date>
    <releaseinfo>$Id: get_user_stats.xml,v 1.3 2004/03/11 17:35:24 tdb Exp $</releaseinfo>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>get_user_stats</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>i-scream</refmiscinfo>
  </refmeta>
  
  <refnamediv>
    <refname>get_user_stats</refname>
    <refpurpose>get the current logged in users</refpurpose>
  </refnamediv>
    
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>user_stat_t *<function>get_user_stats</function></funcdef>
        <void/>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
    
  <refsect1>
    <title>Description</title>
    <para>
      This call returns a pointer to a static buffer of
      <structname>user_stat_t</structname>.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Return Values</title>

    <para>
      The structure returned is of type
      <structname>user_stat_t</structname>.
    </para>

    <programlisting>
typedef struct{
        char *name_list;
        int num_entries;
}user_stat_t;
    </programlisting>

    <variablelist>
      <varlistentry>
        <term><structfield>name_list</structfield></term>
        <listitem>
          <para>
            A pointer to a space seperated list of the currently
            logged in users.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><structfield>num_entries</structfield></term>
        <listitem>
          <para>
            The number of users currently logged in.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <simplelist type="inline">
      <member>
        <citerefentry>
          <refentrytitle>statgrab</refentrytitle>
          <manvolnum>3</manvolnum>
        </citerefentry>
      </member>
    </simplelist>
  </refsect1>
  
  <refsect1>
    <title>Website</title>
    
    <simplelist type="vert">
      <member>
        <ulink url="http://www.i-scream.org/libstatgrab/">
          http://www.i-scream.org/libstatgrab/
        </ulink>
      </member>
    </simplelist>
  </refsect1>

</refentry>
Revision:	1.4
Committed:	Sun May 2 09:35:15 2004 UTC (20 years ago) by tdb
Content type:	text/xml
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.3:	+2 -2 lines
State:	*FILE REMOVED*
Log Message:	Do a repo copy of the documentation to their new names, then delete the old ones. They still need their content updating though. We also need docs for the new process stats stuff, the error reporting code, and I think the FS stats which seem to be missing.
#	Content
1	<?xml version="1.0"?>
2
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_user_stats">
7
8	<refentryinfo>
9	<date>$Date: 2004/03/11 17:35:24 $</date>
10	<releaseinfo>$Id: get_user_stats.xml,v 1.3 2004/03/11 17:35:24 tdb Exp $</releaseinfo>
11	</refentryinfo>
12
13	<refmeta>
14	<refentrytitle>get_user_stats</refentrytitle>
15	<manvolnum>3</manvolnum>
16	<refmiscinfo>i-scream</refmiscinfo>
17	</refmeta>
18
19	<refnamediv>
20	<refname>get_user_stats</refname>
21	<refpurpose>get the current logged in users</refpurpose>
22	</refnamediv>
23
24	<refsynopsisdiv>
25	<funcsynopsis>
26	<funcsynopsisinfo>#include <statgrab.h></funcsynopsisinfo>
27	<funcprototype>
28	<funcdef>user_stat_t *<function>get_user_stats</function></funcdef>
29	<void/>
30	</funcprototype>
31	</funcsynopsis>
32	</refsynopsisdiv>
33
34	<refsect1>
35	<title>Description</title>
36	<para>
37	This call returns a pointer to a static buffer of
38	<structname>user_stat_t</structname>.
39	</para>
40	</refsect1>
41
42	<refsect1>
43	<title>Return Values</title>
44
45	<para>
46	The structure returned is of type
47	<structname>user_stat_t</structname>.
48	</para>
49
50	<programlisting>
51	typedef struct{
52	char *name_list;
53	int num_entries;
54	}user_stat_t;
55	</programlisting>
56
57	<variablelist>
58	<varlistentry>
59	<term><structfield>name_list</structfield></term>
60	<listitem>
61	<para>
62	A pointer to a space seperated list of the currently
63	logged in users.
64	</para>
65	</listitem>
66	</varlistentry>
67	<varlistentry>
68	<term><structfield>num_entries</structfield></term>
69	<listitem>
70	<para>
71	The number of users currently logged in.
72	</para>
73	</listitem>
74	</varlistentry>
75	</variablelist>
76	</refsect1>
77
78	<refsect1>
79	<title>See Also</title>
80
81	<simplelist type="inline">
82	<member>
83	<citerefentry>
84	<refentrytitle>statgrab</refentrytitle>
85	<manvolnum>3</manvolnum>
86	</citerefentry>
87	</member>
88	</simplelist>
89	</refsect1>
90
91	<refsect1>
92	<title>Website</title>
93
94	<simplelist type="vert">
95	<member>
96	<ulink url="http://www.i-scream.org/libstatgrab/">
97	http://www.i-scream.org/libstatgrab/
98	</ulink>
99	</member>
100	</simplelist>
101	</refsect1>
102
103	</refentry>