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
|
<?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="OobsShare">
<refmeta>
<refentrytitle role="top_of_page" id="OobsShare.top_of_page">OobsShare</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsShare</refname>
<refpurpose>Base object for shared folders.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsShare.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsShare-struct">OobsShare</link>;
const <link linkend="gchar">gchar</link>* <link linkend="oobs-share-get-path">oobs_share_get_path</link> (<link linkend="OobsShare">OobsShare</link> *share);
<link linkend="void">void</link> <link linkend="oobs-share-set-path">oobs_share_set_path</link> (<link linkend="OobsShare">OobsShare</link> *share,
const <link linkend="gchar">gchar</link> *path);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsShare.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----OobsShare
+----<link linkend="OobsShareNFS">OobsShareNFS</link>
+----<link linkend="OobsShareSMB">OobsShareSMB</link>
</synopsis>
</refsect1>
<refsect1 id="OobsShare.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsShare--path">path</link>" <link linkend="gchar">gchar</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsShare.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsShare.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsShare-struct" role="struct">
<title>OobsShare</title>
<indexterm zone="OobsShare-struct"><primary>OobsShare</primary></indexterm><programlisting>typedef struct _OobsShare OobsShare;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-share-get-path" role="function">
<title>oobs_share_get_path ()</title>
<indexterm zone="oobs-share-get-path"><primary>oobs_share_get_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_share_get_path (<link linkend="OobsShare">OobsShare</link> *share);</programlisting>
<para>
Returns the path that <link linkend="share"><type>share</type></link> shares.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShare"><type>OobsShare</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the shared path as a string.
This string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-share-set-path" role="function">
<title>oobs_share_set_path ()</title>
<indexterm zone="oobs-share-set-path"><primary>oobs_share_set_path</primary></indexterm><programlisting><link linkend="void">void</link> oobs_share_set_path (<link linkend="OobsShare">OobsShare</link> *share,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<para>
Sets the shared path of <link linkend="share"><type>share</type></link> to be <link linkend="path"><type>path</type></link>,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>share</parameter> :</term>
<listitem><simpara> An <link linkend="OobsShare"><type>OobsShare</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> A new shared path for <link linkend="share"><type>share</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsShare.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsShare--path"><title>The <literal>"path"</literal> property</title>
<indexterm zone="OobsShare--path"><primary>OobsShare:path</primary></indexterm><programlisting> "path" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Path for the share.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
