| 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>OobsShare</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="OobsNFSConfig.html" title="OobsNFSConfig"> |
| 10 |
<link rel="next" href="OobsShareNFS.html" title="OobsShareNFS"> |
| 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="OobsNFSConfig.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="OobsShareNFS.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="#OobsShare.synopsis" class="shortcut">Top</a> |
| 25 |
| |
| 26 |
<a href="#OobsShare.description" class="shortcut">Description</a> |
| 27 |
| |
| 28 |
<a href="#OobsShare.object-hierarchy" class="shortcut">Object Hierarchy</a> |
| 29 |
| |
| 30 |
<a href="#OobsShare.properties" class="shortcut">Properties</a> |
| 31 |
</td></tr> |
| 32 |
</table> |
| 33 |
<div class="refentry" title="OobsShare"> |
| 34 |
<a name="OobsShare"></a><div class="titlepage"></div> |
| 35 |
<div class="refnamediv"><table width="100%"><tr> |
| 36 |
<td valign="top"> |
| 37 |
<h2><span class="refentrytitle"><a name="OobsShare.top_of_page"></a>OobsShare</span></h2> |
| 38 |
<p>OobsShare — Base object for shared folders</p> |
| 39 |
</td> |
| 40 |
<td valign="top" align="right"></td> |
| 41 |
</tr></table></div> |
| 42 |
<div class="refsynopsisdiv" title="Synopsis"> |
| 43 |
<a name="OobsShare.synopsis"></a><h2>Synopsis</h2> |
| 44 |
<pre class="synopsis"> <a class="link" href="OobsShare.html#OobsShare-struct" title="OobsShare">OobsShare</a>; |
| 45 |
<a class="link" href="OobsShare.html#OobsShareClass" title="OobsShareClass">OobsShareClass</a>; |
| 46 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsShare.html#oobs-share-get-path" title="oobs_share_get_path ()">oobs_share_get_path</a> (<em class="parameter"><code><a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a> *share</code></em>); |
| 47 |
<span class="returnvalue">void</span> <a class="link" href="OobsShare.html#oobs-share-set-path" title="oobs_share_set_path ()">oobs_share_set_path</a> (<em class="parameter"><code><a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a> *share</code></em>, |
| 48 |
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>); |
| 49 |
</pre> |
| 50 |
</div> |
| 51 |
<div class="refsect1" title="Object Hierarchy"> |
| 52 |
<a name="OobsShare.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 53 |
<pre class="synopsis"> |
| 54 |
GObject |
| 55 |
+----OobsShare |
| 56 |
+----<a class="link" href="OobsShareNFS.html" title="OobsShareNFS">OobsShareNFS</a> |
| 57 |
+----<a class="link" href="OobsShareSMB.html" title="OobsShareSMB">OobsShareSMB</a> |
| 58 |
</pre> |
| 59 |
</div> |
| 60 |
<div class="refsect1" title="Properties"> |
| 61 |
<a name="OobsShare.properties"></a><h2>Properties</h2> |
| 62 |
<pre class="synopsis"> |
| 63 |
"<a class="link" href="OobsShare.html#OobsShare--path" title='The "path" property'>path</a>" <span class="type">gchar</span>* : Read / Write |
| 64 |
</pre> |
| 65 |
</div> |
| 66 |
<div class="refsect1" title="Description"> |
| 67 |
<a name="OobsShare.description"></a><h2>Description</h2> |
| 68 |
</div> |
| 69 |
<div class="refsect1" title="Details"> |
| 70 |
<a name="OobsShare.details"></a><h2>Details</h2> |
| 71 |
<div class="refsect2" title="OobsShare"> |
| 72 |
<a name="OobsShare-struct"></a><h3>OobsShare</h3> |
| 73 |
<pre class="programlisting">typedef struct _OobsShare OobsShare;</pre> |
| 74 |
<p> |
| 75 |
</p> |
| 76 |
</div> |
| 77 |
<hr> |
| 78 |
<div class="refsect2" title="OobsShareClass"> |
| 79 |
<a name="OobsShareClass"></a><h3>OobsShareClass</h3> |
| 80 |
<pre class="programlisting">typedef struct { |
| 81 |
GObjectClass parent_class; |
| 82 |
|
| 83 |
void (*_oobs_padding1) (void); |
| 84 |
void (*_oobs_padding2) (void); |
| 85 |
} OobsShareClass; |
| 86 |
</pre> |
| 87 |
<p> |
| 88 |
</p> |
| 89 |
</div> |
| 90 |
<hr> |
| 91 |
<div class="refsect2" title="oobs_share_get_path ()"> |
| 92 |
<a name="oobs-share-get-path"></a><h3>oobs_share_get_path ()</h3> |
| 93 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_share_get_path (<em class="parameter"><code><a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a> *share</code></em>);</pre> |
| 94 |
<p> |
| 95 |
Returns the path that <span class="type">share</span> shares. |
| 96 |
</p> |
| 97 |
<div class="variablelist"><table border="0"> |
| 98 |
<col align="left" valign="top"> |
| 99 |
<tbody> |
| 100 |
<tr> |
| 101 |
<td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td> |
| 102 |
<td>An <a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a>. |
| 103 |
</td> |
| 104 |
</tr> |
| 105 |
<tr> |
| 106 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 107 |
<td> A pointer to the shared path as a string. |
| 108 |
This string must not be freed, modified or stored. |
| 109 |
</td> |
| 110 |
</tr> |
| 111 |
</tbody> |
| 112 |
</table></div> |
| 113 |
</div> |
| 114 |
<hr> |
| 115 |
<div class="refsect2" title="oobs_share_set_path ()"> |
| 116 |
<a name="oobs-share-set-path"></a><h3>oobs_share_set_path ()</h3> |
| 117 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_share_set_path (<em class="parameter"><code><a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a> *share</code></em>, |
| 118 |
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre> |
| 119 |
<p> |
| 120 |
Sets the shared path of <span class="type">share</span> to be <span class="type">path</span>, |
| 121 |
overwriting the previous one. |
| 122 |
</p> |
| 123 |
<div class="variablelist"><table border="0"> |
| 124 |
<col align="left" valign="top"> |
| 125 |
<tbody> |
| 126 |
<tr> |
| 127 |
<td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td> |
| 128 |
<td>An <a class="link" href="OobsShare.html" title="OobsShare"><span class="type">OobsShare</span></a>. |
| 129 |
</td> |
| 130 |
</tr> |
| 131 |
<tr> |
| 132 |
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> |
| 133 |
<td>A new shared path for <span class="type">share</span>. |
| 134 |
</td> |
| 135 |
</tr> |
| 136 |
</tbody> |
| 137 |
</table></div> |
| 138 |
</div> |
| 139 |
</div> |
| 140 |
<div class="refsect1" title="Property Details"> |
| 141 |
<a name="OobsShare.property-details"></a><h2>Property Details</h2> |
| 142 |
<div class="refsect2" title='The "path" property'> |
| 143 |
<a name="OobsShare--path"></a><h3>The <code class="literal">"path"</code> property</h3> |
| 144 |
<pre class="programlisting"> "path" <span class="type">gchar</span>* : Read / Write</pre> |
| 145 |
<p>Path for the share.</p> |
| 146 |
<p>Default value: NULL</p> |
| 147 |
</div> |
| 148 |
</div> |
| 149 |
<div class="refsect1" title="See Also"> |
| 150 |
<a name="OobsShare.see-also"></a><h2>See Also</h2> |
| 151 |
<a class="link" href="OobsShareNFS.html" title="OobsShareNFS"><span class="type">OobsShareNFS</span></a>, <a class="link" href="OobsShareSMB.html" title="OobsShareSMB"><span class="type">OobsShareSMB</span></a> |
| 152 |
</div> |
| 153 |
</div> |
| 154 |
<div class="footer"> |
| 155 |
<hr> |
| 156 |
Generated by GTK-Doc V1.15</div> |
| 157 |
</body> |
| 158 |
</html> |