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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<?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="OobsSMBConfig">
<refmeta>
<refentrytitle role="top_of_page" id="OobsSMBConfig.top_of_page">OobsSMBConfig</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsSMBConfig</refname>
<refpurpose>Object that represents SMB configuration.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsSMBConfig.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsSMBConfig-struct">OobsSMBConfig</link>;
<link linkend="OobsObject">OobsObject</link>* <link linkend="oobs-smb-config-get">oobs_smb_config_get</link> (void);
<link linkend="OobsList">OobsList</link>* <link linkend="oobs-smb-config-get-shares">oobs_smb_config_get_shares</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-smb-config-get-description">oobs_smb_config_get_description</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-smb-config-set-description">oobs_smb_config_set_description</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
const <link linkend="gchar">gchar</link> *description);
<link linkend="gboolean">gboolean</link> <link linkend="oobs-smb-config-get-is-wins-server">oobs_smb_config_get_is_wins_server</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-smb-config-set-is-wins-server">oobs_smb_config_set_is_wins_server</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
<link linkend="gboolean">gboolean</link> is_wins_server);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-smb-config-get-wins-server">oobs_smb_config_get_wins_server</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-smb-config-set-wins-server">oobs_smb_config_set_wins_server</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
const <link linkend="gchar">gchar</link> *wins_server);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-smb-config-get-workgroup">oobs_smb_config_get_workgroup</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-smb-config-set-workgroup">oobs_smb_config_set_workgroup</link> (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
const <link linkend="gchar">gchar</link> *workgroup);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsSMBConfig.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsObject">OobsObject</link>
+----OobsSMBConfig
</synopsis>
</refsect1>
<refsect1 id="OobsSMBConfig.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsSMBConfig--description">description</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsSMBConfig--is-wins-server">is-wins-server</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="OobsSMBConfig--wins-server">wins-server</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsSMBConfig--workgroup">workgroup</link>" <link linkend="gchar">gchar</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsSMBConfig.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsSMBConfig.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsSMBConfig-struct" role="struct">
<title>OobsSMBConfig</title>
<indexterm zone="OobsSMBConfig-struct"><primary>OobsSMBConfig</primary></indexterm><programlisting>typedef struct _OobsSMBConfig OobsSMBConfig;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-smb-config-get" role="function">
<title>oobs_smb_config_get ()</title>
<indexterm zone="oobs-smb-config-get"><primary>oobs_smb_config_get</primary></indexterm><programlisting><link linkend="OobsObject">OobsObject</link>* oobs_smb_config_get (void);</programlisting>
<para>
Returns the <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link> singleton, which represents
the SMB system configuration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the singleton <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-get-shares" role="function">
<title>oobs_smb_config_get_shares ()</title>
<indexterm zone="oobs-smb-config-get-shares"><primary>oobs_smb_config_get_shares</primary></indexterm><programlisting><link linkend="OobsList">OobsList</link>* oobs_smb_config_get_shares (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);</programlisting>
<para>
Returns an <link linkend="OobsList"><type>OobsList</type></link> containing objects of type <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an <link linkend="OobsList"><type>OobsList</type></link> containing the SMB shares information.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-get-description" role="function">
<title>oobs_smb_config_get_description ()</title>
<indexterm zone="oobs-smb-config-get-description"><primary>oobs_smb_config_get_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_smb_config_get_description (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);</programlisting>
<para>
Returns the SMB host description.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the host description as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-set-description" role="function">
<title>oobs_smb_config_set_description ()</title>
<indexterm zone="oobs-smb-config-set-description"><primary>oobs_smb_config_set_description</primary></indexterm><programlisting><link linkend="void">void</link> oobs_smb_config_set_description (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
const <link linkend="gchar">gchar</link> *description);</programlisting>
<para>
Sets a new SMB host description, overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description</parameter> :</term>
<listitem><simpara> a new host description.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-get-is-wins-server" role="function">
<title>oobs_smb_config_get_is_wins_server ()</title>
<indexterm zone="oobs-smb-config-get-is-wins-server"><primary>oobs_smb_config_get_is_wins_server</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_smb_config_get_is_wins_server (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);</programlisting>
<para>
Returns whether the host is a WINS server for the network.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the host is a WINS server.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-set-is-wins-server" role="function">
<title>oobs_smb_config_set_is_wins_server ()</title>
<indexterm zone="oobs-smb-config-set-is-wins-server"><primary>oobs_smb_config_set_is_wins_server</primary></indexterm><programlisting><link linkend="void">void</link> oobs_smb_config_set_is_wins_server (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
<link linkend="gboolean">gboolean</link> is_wins_server);</programlisting>
<para>
Sets whether the host is a WINS server for the network. Note that there
must be only one WINS server, so if there's already a WINS server in the
network, there wouldn't be the need to set the host as another WINS server.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>is_wins_server</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the host is the WINS server for the network.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-get-wins-server" role="function">
<title>oobs_smb_config_get_wins_server ()</title>
<indexterm zone="oobs-smb-config-get-wins-server"><primary>oobs_smb_config_get_wins_server</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_smb_config_get_wins_server (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);</programlisting>
<para>
Returns the WINS server the host is using.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the wins server as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-set-wins-server" role="function">
<title>oobs_smb_config_set_wins_server ()</title>
<indexterm zone="oobs-smb-config-set-wins-server"><primary>oobs_smb_config_set_wins_server</primary></indexterm><programlisting><link linkend="void">void</link> oobs_smb_config_set_wins_server (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
const <link linkend="gchar">gchar</link> *wins_server);</programlisting>
<para>
Sets the WINS server that the host will use. This option is
mutually exclusive with <link linkend="oobs-smb-config-set-is-wins-server"><function>oobs_smb_config_set_is_wins_server()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wins_server</parameter> :</term>
<listitem><simpara> a new WINS server.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-get-workgroup" role="function">
<title>oobs_smb_config_get_workgroup ()</title>
<indexterm zone="oobs-smb-config-get-workgroup"><primary>oobs_smb_config_get_workgroup</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_smb_config_get_workgroup (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config);</programlisting>
<para>
Returns the SMB workgroup for the host.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the workgroup as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-smb-config-set-workgroup" role="function">
<title>oobs_smb_config_set_workgroup ()</title>
<indexterm zone="oobs-smb-config-set-workgroup"><primary>oobs_smb_config_set_workgroup</primary></indexterm><programlisting><link linkend="void">void</link> oobs_smb_config_set_workgroup (<link linkend="OobsSMBConfig">OobsSMBConfig</link> *config,
const <link linkend="gchar">gchar</link> *workgroup);</programlisting>
<para>
Sets a new SMB workgroup for the host, overwriting the
previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSMBConfig"><type>OobsSMBConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>workgroup</parameter> :</term>
<listitem><simpara> a new SMB workgroup for the host.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsSMBConfig.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsSMBConfig--description"><title>The <literal>"description"</literal> property</title>
<indexterm zone="OobsSMBConfig--description"><primary>OobsSMBConfig:description</primary></indexterm><programlisting> "description" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Description for this host.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsSMBConfig--is-wins-server"><title>The <literal>"is-wins-server"</literal> property</title>
<indexterm zone="OobsSMBConfig--is-wins-server"><primary>OobsSMBConfig:is-wins-server</primary></indexterm><programlisting> "is-wins-server" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Whether the host is the WINS server.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="OobsSMBConfig--wins-server"><title>The <literal>"wins-server"</literal> property</title>
<indexterm zone="OobsSMBConfig--wins-server"><primary>OobsSMBConfig:wins-server</primary></indexterm><programlisting> "wins-server" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>WINS server that the host will use.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsSMBConfig--workgroup"><title>The <literal>"workgroup"</literal> property</title>
<indexterm zone="OobsSMBConfig--workgroup"><primary>OobsSMBConfig:workgroup</primary></indexterm><programlisting> "workgroup" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Workgroup/domain the host is in.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
