Debian Codegraph @

doc/reference/html/OobsShareSMB.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>OobsShareSMB</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual">
8 <link rel="up" href="ch03.html" title="Shared folders management">
9 <link rel="prev" href="OobsShareNFS.html" title="OobsShareNFS">
10 <link rel="next" href="ch04.html" title="Date and time management">
11 <meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="OobsShareNFS.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
21 <td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#OobsShareSMB.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsShareSMB.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsShareSMB.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#OobsShareSMB.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry" title="OobsShareSMB">
34 <a name="OobsShareSMB"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="OobsShareSMB.top_of_page"></a>OobsShareSMB</span></h2>
38 <p>OobsShareSMB — Object that represents SMB configuration.</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv" title="Synopsis">
43 <a name="OobsShareSMB.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis">enum <a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags">OobsShareSMBFlags</a>;
45 #define <a class="link" href="OobsShareSMB.html#OOBS-TYPE-SHARE-SMB-FLAGS:CAPS" title="OOBS_TYPE_SHARE_SMB_FLAGS">OOBS_TYPE_SHARE_SMB_FLAGS</a>
46 <a class="link" href="OobsShareSMB.html#OobsShareSMB-struct" title="OobsShareSMB">OobsShareSMB</a>;
47 <a class="link" href="OobsShareSMB.html#OobsShareSMBClass" title="OobsShareSMBClass">OobsShareSMBClass</a>;
48 <span class="returnvalue">GType</span> <a class="link" href="OobsShareSMB.html#oobs-share-smb-flags-get-type" title="oobs_share_smb_flags_get_type ()">oobs_share_smb_flags_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
49 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsShareSMB.html#oobs-share-smb-get-name" title="oobs_share_smb_get_name ()">oobs_share_smb_get_name</a> (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>);
50 <span class="returnvalue">void</span> <a class="link" href="OobsShareSMB.html#oobs-share-smb-set-name" title="oobs_share_smb_set_name ()">oobs_share_smb_set_name</a> (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>,
51 <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
52 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsShareSMB.html#oobs-share-smb-get-comment" title="oobs_share_smb_get_comment ()">oobs_share_smb_get_comment</a> (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>);
53 <span class="returnvalue">void</span> <a class="link" href="OobsShareSMB.html#oobs-share-smb-set-comment" title="oobs_share_smb_set_comment ()">oobs_share_smb_set_comment</a> (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>,
54 <em class="parameter"><code>const <span class="type">gchar</span> *comment</code></em>);
55 <a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="returnvalue">OobsShareSMBFlags</span></a> <a class="link" href="OobsShareSMB.html#oobs-share-smb-get-flags" title="oobs_share_smb_get_flags ()">oobs_share_smb_get_flags</a> (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>);
56 <span class="returnvalue">void</span> <a class="link" href="OobsShareSMB.html#oobs-share-smb-set-flags" title="oobs_share_smb_set_flags ()">oobs_share_smb_set_flags</a> (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>,
57 <em class="parameter"><code><a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="type">OobsShareSMBFlags</span></a> flags</code></em>);
58 <a class="link" href="OobsShare.html" title="OobsShare"><span class="returnvalue">OobsShare</span></a>* <a class="link" href="OobsShareSMB.html#oobs-share-smb-new" title="oobs_share_smb_new ()">oobs_share_smb_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
59 <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
60 <em class="parameter"><code>const <span class="type">gchar</span> *comment</code></em>,
61 <em class="parameter"><code><a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="type">OobsShareSMBFlags</span></a> flags</code></em>);
62 </pre>
63 </div>
64 <div class="refsect1" title="Object Hierarchy">
65 <a name="OobsShareSMB.object-hierarchy"></a><h2>Object Hierarchy</h2>
66 <pre class="synopsis">
67 GObject
68 +----<a class="link" href="OobsShare.html" title="OobsShare">OobsShare</a>
69 +----OobsShareSMB
70 </pre>
71 </div>
72 <div class="refsect1" title="Properties">
73 <a name="OobsShareSMB.properties"></a><h2>Properties</h2>
74 <pre class="synopsis">
75 "<a class="link" href="OobsShareSMB.html#OobsShareSMB--comment" title='The "comment" property'>comment</a>" <span class="type">gchar</span>* : Read / Write / Construct
76 "<a class="link" href="OobsShareSMB.html#OobsShareSMB--flags" title='The "flags" property'>flags</a>" <a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="type">OobsShareSMBFlags</span></a> : Read / Write / Construct
77 "<a class="link" href="OobsShareSMB.html#OobsShareSMB--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct
78 </pre>
79 </div>
80 <div class="refsect1" title="Description">
81 <a name="OobsShareSMB.description"></a><h2>Description</h2>
82 </div>
83 <div class="refsect1" title="Details">
84 <a name="OobsShareSMB.details"></a><h2>Details</h2>
85 <div class="refsect2" title="enum OobsShareSMBFlags">
86 <a name="OobsShareSMBFlags"></a><h3>enum OobsShareSMBFlags</h3>
87 <pre class="programlisting">typedef enum {
88 OOBS_SHARE_SMB_ENABLED = 1 &lt;&lt; 0,
89 OOBS_SHARE_SMB_BROWSABLE = 1 &lt;&lt; 1,
90 OOBS_SHARE_SMB_PUBLIC = 1 &lt;&lt; 2,
91 OOBS_SHARE_SMB_WRITABLE = 1 &lt;&lt; 3,
92 } OobsShareSMBFlags;
93 </pre>
94 <p>
95 </p>
96 </div>
97 <hr>
98 <div class="refsect2" title="OOBS_TYPE_SHARE_SMB_FLAGS">
99 <a name="OOBS-TYPE-SHARE-SMB-FLAGS:CAPS"></a><h3>OOBS_TYPE_SHARE_SMB_FLAGS</h3>
100 <pre class="programlisting">#define OOBS_TYPE_SHARE_SMB_FLAGS</pre>
101 <p>
102 </p>
103 </div>
104 <hr>
105 <div class="refsect2" title="OobsShareSMB">
106 <a name="OobsShareSMB-struct"></a><h3>OobsShareSMB</h3>
107 <pre class="programlisting">typedef struct _OobsShareSMB OobsShareSMB;</pre>
108 <p>
109 </p>
110 </div>
111 <hr>
112 <div class="refsect2" title="OobsShareSMBClass">
113 <a name="OobsShareSMBClass"></a><h3>OobsShareSMBClass</h3>
114 <pre class="programlisting">typedef struct {
115 OobsShareClass parent_class;
116
117 void (*_oobs_padding1) (void);
118 void (*_oobs_padding2) (void);
119 } OobsShareSMBClass;
120 </pre>
121 <p>
122 </p>
123 </div>
124 <hr>
125 <div class="refsect2" title="oobs_share_smb_flags_get_type ()">
126 <a name="oobs-share-smb-flags-get-type"></a><h3>oobs_share_smb_flags_get_type ()</h3>
127 <pre class="programlisting"><span class="returnvalue">GType</span> oobs_share_smb_flags_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
128 <p>
129 </p>
130 <div class="variablelist"><table border="0">
131 <col align="left" valign="top">
132 <tbody><tr>
133 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
134 <td>
135 </td>
136 </tr></tbody>
137 </table></div>
138 </div>
139 <hr>
140 <div class="refsect2" title="oobs_share_smb_get_name ()">
141 <a name="oobs-share-smb-get-name"></a><h3>oobs_share_smb_get_name ()</h3>
142 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_share_smb_get_name (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>);</pre>
143 <p>
144 Returns the share name.
145 </p>
146 <div class="variablelist"><table border="0">
147 <col align="left" valign="top">
148 <tbody>
149 <tr>
150 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
151 <td>An <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a>.
152 </td>
153 </tr>
154 <tr>
155 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
156 <td> A pointer to the share name as a string. This
157 string must not be freed, modified or stored.
158 </td>
159 </tr>
160 </tbody>
161 </table></div>
162 </div>
163 <hr>
164 <div class="refsect2" title="oobs_share_smb_set_name ()">
165 <a name="oobs-share-smb-set-name"></a><h3>oobs_share_smb_set_name ()</h3>
166 <pre class="programlisting"><span class="returnvalue">void</span> oobs_share_smb_set_name (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>,
167 <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
168 <p>
169 Sets a new name for the share, overwriting the previous one.
170 </p>
171 <div class="variablelist"><table border="0">
172 <col align="left" valign="top">
173 <tbody>
174 <tr>
175 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
176 <td>An <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a>.
177 </td>
178 </tr>
179 <tr>
180 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
181 <td>new name for the share.
182 </td>
183 </tr>
184 </tbody>
185 </table></div>
186 </div>
187 <hr>
188 <div class="refsect2" title="oobs_share_smb_get_comment ()">
189 <a name="oobs-share-smb-get-comment"></a><h3>oobs_share_smb_get_comment ()</h3>
190 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_share_smb_get_comment (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>);</pre>
191 <p>
192 Returns the comment for the share.
193 </p>
194 <div class="variablelist"><table border="0">
195 <col align="left" valign="top">
196 <tbody>
197 <tr>
198 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
199 <td>An <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a>.
200 </td>
201 </tr>
202 <tr>
203 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
204 <td> A pointer to the share comment as a string. This
205 string must not be freed, modified or stored.
206 </td>
207 </tr>
208 </tbody>
209 </table></div>
210 </div>
211 <hr>
212 <div class="refsect2" title="oobs_share_smb_set_comment ()">
213 <a name="oobs-share-smb-set-comment"></a><h3>oobs_share_smb_set_comment ()</h3>
214 <pre class="programlisting"><span class="returnvalue">void</span> oobs_share_smb_set_comment (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>,
215 <em class="parameter"><code>const <span class="type">gchar</span> *comment</code></em>);</pre>
216 <p>
217 Sets a new comment for the share, overwriting the previous one.
218 </p>
219 <div class="variablelist"><table border="0">
220 <col align="left" valign="top">
221 <tbody>
222 <tr>
223 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
224 <td>An <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a>.
225 </td>
226 </tr>
227 <tr>
228 <td><p><span class="term"><em class="parameter"><code>comment</code></em> :</span></p></td>
229 <td>new comment for the share.
230 </td>
231 </tr>
232 </tbody>
233 </table></div>
234 </div>
235 <hr>
236 <div class="refsect2" title="oobs_share_smb_get_flags ()">
237 <a name="oobs-share-smb-get-flags"></a><h3>oobs_share_smb_get_flags ()</h3>
238 <pre class="programlisting"><a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="returnvalue">OobsShareSMBFlags</span></a> oobs_share_smb_get_flags (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>);</pre>
239 <p>
240 Returns the options mask of the share.
241 </p>
242 <div class="variablelist"><table border="0">
243 <col align="left" valign="top">
244 <tbody>
245 <tr>
246 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
247 <td>An <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a>.
248 </td>
249 </tr>
250 <tr>
251 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
252 <td> <a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="type">OobsShareSMBFlags</span></a> mask representing the share options.
253 </td>
254 </tr>
255 </tbody>
256 </table></div>
257 </div>
258 <hr>
259 <div class="refsect2" title="oobs_share_smb_set_flags ()">
260 <a name="oobs-share-smb-set-flags"></a><h3>oobs_share_smb_set_flags ()</h3>
261 <pre class="programlisting"><span class="returnvalue">void</span> oobs_share_smb_set_flags (<em class="parameter"><code><a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> *share</code></em>,
262 <em class="parameter"><code><a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="type">OobsShareSMBFlags</span></a> flags</code></em>);</pre>
263 <p>
264 Sets a new set of options for the share.
265 </p>
266 <div class="variablelist"><table border="0">
267 <col align="left" valign="top">
268 <tbody>
269 <tr>
270 <td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
271 <td>An <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a>.
272 </td>
273 </tr>
274 <tr>
275 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
276 <td>mask of options for the share.
277 </td>
278 </tr>
279 </tbody>
280 </table></div>
281 </div>
282 <hr>
283 <div class="refsect2" title="oobs_share_smb_new ()">
284 <a name="oobs-share-smb-new"></a><h3>oobs_share_smb_new ()</h3>
285 <pre class="programlisting"><a class="link" href="OobsShare.html" title="OobsShare"><span class="returnvalue">OobsShare</span></a>* oobs_share_smb_new (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
286 <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
287 <em class="parameter"><code>const <span class="type">gchar</span> *comment</code></em>,
288 <em class="parameter"><code><a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="type">OobsShareSMBFlags</span></a> flags</code></em>);</pre>
289 <p>
290 Creates a new <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> with the given settings.
291 </p>
292 <div class="variablelist"><table border="0">
293 <col align="left" valign="top">
294 <tbody>
295 <tr>
296 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
297 <td>folder path for the new share.
298 </td>
299 </tr>
300 <tr>
301 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
302 <td>name for the new share.
303 </td>
304 </tr>
305 <tr>
306 <td><p><span class="term"><em class="parameter"><code>comment</code></em> :</span></p></td>
307 <td>comment for the new share.
308 </td>
309 </tr>
310 <tr>
311 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
312 <td>options mask for the new share.
313 </td>
314 </tr>
315 <tr>
316 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
317 <td> a newly allocated <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a>.
318 </td>
319 </tr>
320 </tbody>
321 </table></div>
322 </div>
323 </div>
324 <div class="refsect1" title="Property Details">
325 <a name="OobsShareSMB.property-details"></a><h2>Property Details</h2>
326 <div class="refsect2" title='The "comment" property'>
327 <a name="OobsShareSMB--comment"></a><h3>The <code class="literal">"comment"</code> property</h3>
328 <pre class="programlisting"> "comment" <span class="type">gchar</span>* : Read / Write / Construct</pre>
329 <p>Comment for the share.</p>
330 <p>Default value: NULL</p>
331 </div>
332 <hr>
333 <div class="refsect2" title='The "flags" property'>
334 <a name="OobsShareSMB--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
335 <pre class="programlisting"> "flags" <a class="link" href="OobsShareSMB.html#OobsShareSMBFlags" title="enum OobsShareSMBFlags"><span class="type">OobsShareSMBFlags</span></a> : Read / Write / Construct</pre>
336 <p>Property flags for the share.</p>
337 </div>
338 <hr>
339 <div class="refsect2" title='The "name" property'>
340 <a name="OobsShareSMB--name"></a><h3>The <code class="literal">"name"</code> property</h3>
341 <pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct</pre>
342 <p></p>
343 <p>Default value: NULL</p>
344 </div>
345 </div>
346 <div class="refsect1" title="See Also">
347 <a name="OobsShareSMB.see-also"></a><h2>See Also</h2>
348 <a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a>, <a class="link" href="OobsSMBConfig.html" title="OobsSMBConfig"><span class="type">OobsSMBConfig</span></a>
349 </div>
350 </div>
351 <div class="footer">
352 <hr>
353 Generated by GTK-Doc V1.15</div>
354 </body>
355 </html>