ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/libstatgrab/docs/get_user_stats.xml
Revision: 1.1
Committed: Thu Oct 2 15:32:42 2003 UTC (21 years, 1 month ago) by tdb
Content type: text/xml
Branch: MAIN
Log Message:
Add user statistics.

File Contents

# 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$</date>
10 <releaseinfo>$Id$</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 &lt;statgrab.h&gt;</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 <para>Nothing yet</para>
81 </refsect1>
82
83 <refsect1>
84 <title>Website</title>
85
86 <simplelist type="vert">
87 <member>
88 <ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink>
89 </member>
90 </simplelist>
91 </refsect1>
92
93 </refentry>