1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="OobsGroupsConfig">
<refmeta>
<refentrytitle role="top_of_page" id="OobsGroupsConfig.top_of_page">OobsGroupsConfig</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsGroupsConfig</refname>
<refpurpose>Object that represents groups configuration.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsGroupsConfig.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsGroupsConfig-struct">OobsGroupsConfig</link>;
<link linkend="OobsObject">OobsObject</link>* <link linkend="oobs-groups-config-get">oobs_groups_config_get</link> (void);
<link linkend="OobsList">OobsList</link>* <link linkend="oobs-groups-config-get-groups">oobs_groups_config_get_groups</link> (<link linkend="OobsGroupsConfig">OobsGroupsConfig</link> *config);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsGroupsConfig.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsObject">OobsObject</link>
+----OobsGroupsConfig
</synopsis>
</refsect1>
<refsect1 id="OobsGroupsConfig.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsGroupsConfig--maximum-gid">maximum-gid</link>" <link linkend="gint">gint</link> : Read / Write
"<link linkend="OobsGroupsConfig--minimum-gid">minimum-gid</link>" <link linkend="gint">gint</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsGroupsConfig.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsGroupsConfig.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsGroupsConfig-struct" role="struct">
<title>OobsGroupsConfig</title>
<indexterm zone="OobsGroupsConfig-struct"><primary>OobsGroupsConfig</primary></indexterm><programlisting>typedef struct _OobsGroupsConfig OobsGroupsConfig;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-groups-config-get" role="function">
<title>oobs_groups_config_get ()</title>
<indexterm zone="oobs-groups-config-get"><primary>oobs_groups_config_get</primary></indexterm><programlisting><link linkend="OobsObject">OobsObject</link>* oobs_groups_config_get (void);</programlisting>
<para>
Returns the <link linkend="OobsGroupsConfig"><type>OobsGroupsConfig</type></link> singleton, which
represents the groups configuration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the singleton <link linkend="OobsGoupsConfig"><type>OobsGoupsConfig</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-groups-config-get-groups" role="function">
<title>oobs_groups_config_get_groups ()</title>
<indexterm zone="oobs-groups-config-get-groups"><primary>oobs_groups_config_get_groups</primary></indexterm><programlisting><link linkend="OobsList">OobsList</link>* oobs_groups_config_get_groups (<link linkend="OobsGroupsConfig">OobsGroupsConfig</link> *config);</programlisting>
<para>
Returns an <link linkend="OobsList"><type>OobsList</type></link> containing objects of type <link linkend="OobsGroup"><type>OobsGroup</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroupsConfig"><type>OobsGroupsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An OobsList containing the groups configuration.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsGroupsConfig.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsGroupsConfig--maximum-gid"><title>The <literal>"maximum-gid"</literal> property</title>
<indexterm zone="OobsGroupsConfig--maximum-gid"><primary>OobsGroupsConfig:maximum-gid</primary></indexterm><programlisting> "maximum-gid" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>Maximum GID for non-system groups.</para><para>Allowed values: [0,65534]</para>
<para>Default value: 65534</para>
</refsect2>
<refsect2 id="OobsGroupsConfig--minimum-gid"><title>The <literal>"minimum-gid"</literal> property</title>
<indexterm zone="OobsGroupsConfig--minimum-gid"><primary>OobsGroupsConfig:minimum-gid</primary></indexterm><programlisting> "minimum-gid" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>Minimum GID for non-system groups.</para><para>Allowed values: [0,65534]</para>
<para>Default value: 65534</para>
</refsect2>
</refsect1>
</refentry>
|