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
|
<?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="OobsShareSMB">
<refmeta>
<refentrytitle role="top_of_page" id="OobsShareSMB.top_of_page">OobsShareSMB</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsShareSMB</refname>
<refpurpose>Object that represents an individual SMB share.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsShareSMB.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link>;
#define <link linkend="OOBS-TYPE-SHARE-SMB-FLAGS:CAPS">OOBS_TYPE_SHARE_SMB_FLAGS</link>
<link linkend="OobsShareSMB-struct">OobsShareSMB</link>;
const <link linkend="gchar">gchar</link>* <link linkend="oobs-share-smb-get-name">oobs_share_smb_get_name</link> (<link linkend="OobsShareSMB">OobsShareSMB</link> *share);
<link linkend="void">void</link> <link linkend="oobs-share-smb-set-name">oobs_share_smb_set_name</link> (<link linkend="OobsShareSMB">OobsShareSMB</link> *share,
const <link linkend="gchar">gchar</link> *name);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-share-smb-get-comment">oobs_share_smb_get_comment</link> (<link linkend="OobsShareSMB">OobsShareSMB</link> *share);
<link linkend="void">void</link> <link linkend="oobs-share-smb-set-comment">oobs_share_smb_set_comment</link> (<link linkend="OobsShareSMB">OobsShareSMB</link> *share,
const <link linkend="gchar">gchar</link> *comment);
<link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> <link linkend="oobs-share-smb-get-flags">oobs_share_smb_get_flags</link> (<link linkend="OobsShareSMB">OobsShareSMB</link> *share);
<link linkend="void">void</link> <link linkend="oobs-share-smb-set-flags">oobs_share_smb_set_flags</link> (<link linkend="OobsShareSMB">OobsShareSMB</link> *share,
<link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> flags);
<link linkend="OobsShare">OobsShare</link>* <link linkend="oobs-share-smb-new">oobs_share_smb_new</link> (const <link linkend="gchar">gchar</link> *path,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *comment,
<link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> flags);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsShareSMB.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsShare">OobsShare</link>
+----OobsShareSMB
</synopsis>
</refsect1>
<refsect1 id="OobsShareSMB.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsShareSMB--comment">comment</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct
"<link linkend="OobsShareSMB--flags">flags</link>" <link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> : Read / Write / Construct
"<link linkend="OobsShareSMB--name">name</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 id="OobsShareSMB.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsShareSMB.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsShareSMBFlags" role="enum">
<title>enum OobsShareSMBFlags</title>
<indexterm zone="OobsShareSMBFlags"><primary>OobsShareSMBFlags</primary></indexterm><programlisting>typedef enum {
OOBS_SHARE_SMB_ENABLED = 1 << 0,
OOBS_SHARE_SMB_BROWSABLE = 1 << 1,
OOBS_SHARE_SMB_PUBLIC = 1 << 2,
OOBS_SHARE_SMB_WRITABLE = 1 << 3,
} OobsShareSMBFlags;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OOBS-TYPE-SHARE-SMB-FLAGS:CAPS" role="macro">
<title>OOBS_TYPE_SHARE_SMB_FLAGS</title>
<indexterm zone="OOBS-TYPE-SHARE-SMB-FLAGS:CAPS"><primary>OOBS_TYPE_SHARE_SMB_FLAGS</primary></indexterm><programlisting>#define OOBS_TYPE_SHARE_SMB_FLAGS (oobs_share_smb_flags_get_type())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OobsShareSMB-struct" role="struct">
<title>OobsShareSMB</title>
<indexterm zone="OobsShareSMB-struct"><primary>OobsShareSMB</primary></indexterm><programlisting>typedef struct _OobsShareSMB OobsShareSMB;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-share-smb-get-name" role="function">
<title>oobs_share_smb_get_name ()</title>
<indexterm zone="oobs-share-smb-get-name"><primary>oobs_share_smb_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_share_smb_get_name (<link linkend="OobsShareSMB">OobsShareSMB</link> *share);</programlisting>
<para>
Returns the share name.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the share name as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-share-smb-set-name" role="function">
<title>oobs_share_smb_set_name ()</title>
<indexterm zone="oobs-share-smb-set-name"><primary>oobs_share_smb_set_name</primary></indexterm><programlisting><link linkend="void">void</link> oobs_share_smb_set_name (<link linkend="OobsShareSMB">OobsShareSMB</link> *share,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Sets a new name for the share, overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> new name for the share.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-share-smb-get-comment" role="function">
<title>oobs_share_smb_get_comment ()</title>
<indexterm zone="oobs-share-smb-get-comment"><primary>oobs_share_smb_get_comment</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_share_smb_get_comment (<link linkend="OobsShareSMB">OobsShareSMB</link> *share);</programlisting>
<para>
Returns the comment for the share.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the share comment as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-share-smb-set-comment" role="function">
<title>oobs_share_smb_set_comment ()</title>
<indexterm zone="oobs-share-smb-set-comment"><primary>oobs_share_smb_set_comment</primary></indexterm><programlisting><link linkend="void">void</link> oobs_share_smb_set_comment (<link linkend="OobsShareSMB">OobsShareSMB</link> *share,
const <link linkend="gchar">gchar</link> *comment);</programlisting>
<para>
Sets a new comment for the share, overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>comment</parameter> :</term>
<listitem><simpara> new comment for the share.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-share-smb-get-flags" role="function">
<title>oobs_share_smb_get_flags ()</title>
<indexterm zone="oobs-share-smb-get-flags"><primary>oobs_share_smb_get_flags</primary></indexterm><programlisting><link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> oobs_share_smb_get_flags (<link linkend="OobsShareSMB">OobsShareSMB</link> *share);</programlisting>
<para>
Returns the options mask of the share.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="OobsShareSMBFlags"><type>OobsShareSMBFlags</type></link> mask representing the share options.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-share-smb-set-flags" role="function">
<title>oobs_share_smb_set_flags ()</title>
<indexterm zone="oobs-share-smb-set-flags"><primary>oobs_share_smb_set_flags</primary></indexterm><programlisting><link linkend="void">void</link> oobs_share_smb_set_flags (<link linkend="OobsShareSMB">OobsShareSMB</link> *share,
<link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> flags);</programlisting>
<para>
Sets a new set of options for the share.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> mask of options for the share.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-share-smb-new" role="function">
<title>oobs_share_smb_new ()</title>
<indexterm zone="oobs-share-smb-new"><primary>oobs_share_smb_new</primary></indexterm><programlisting><link linkend="OobsShare">OobsShare</link>* oobs_share_smb_new (const <link linkend="gchar">gchar</link> *path,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *comment,
<link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> flags);</programlisting>
<para>
Creates a new <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link> with the given settings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> folder path for the new share.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name for the new share.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>comment</parameter> :</term>
<listitem><simpara> comment for the new share.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> options mask for the new share.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="OobsShareSMB"><type>OobsShareSMB</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsShareSMB.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsShareSMB--comment"><title>The <literal>"comment"</literal> property</title>
<indexterm zone="OobsShareSMB--comment"><primary>OobsShareSMB:comment</primary></indexterm><programlisting> "comment" <link linkend="gchar">gchar</link>* : Read / Write / Construct</programlisting>
<para>Comment for the share.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsShareSMB--flags"><title>The <literal>"flags"</literal> property</title>
<indexterm zone="OobsShareSMB--flags"><primary>OobsShareSMB:flags</primary></indexterm><programlisting> "flags" <link linkend="OobsShareSMBFlags">OobsShareSMBFlags</link> : Read / Write / Construct</programlisting>
<para>Property flags for the share.</para></refsect2>
<refsect2 id="OobsShareSMB--name"><title>The <literal>"name"</literal> property</title>
<indexterm zone="OobsShareSMB--name"><primary>OobsShareSMB:name</primary></indexterm><programlisting> "name" <link linkend="gchar">gchar</link>* : Read / Write / Construct</programlisting>
<para></para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
