summaryrefslogtreecommitdiff
path: root/docs/libnm-glib/html/NMRemoteSettings.html
blob: 259a5b3d9c4d2fe1e10e4d3a90b56082be4d3c02 (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NMRemoteSettings</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libnm-glib Reference Manual">
<link rel="up" href="ch01.html" title="libnm-glib Objects">
<link rel="prev" href="NMRemoteConnection.html" title="NMRemoteConnection">
<link rel="next" href="libnm-glib-NMRemoteSettingsSystem.html" title="NMRemoteSettingsSystem">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="NMRemoteConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libnm-glib Reference Manual</th>
<td><a accesskey="n" href="libnm-glib-NMRemoteSettingsSystem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#NMRemoteSettings.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#NMRemoteSettings.description" class="shortcut">Description</a>
                   | 
                  <a href="#NMRemoteSettings.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#NMRemoteSettings.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#NMRemoteSettings.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="NMRemoteSettings">
<a name="NMRemoteSettings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMRemoteSettings.top_of_page"></a>NMRemoteSettings</span></h2>
<p>NMRemoteSettings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMRemoteSettings.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define             <a class="link" href="NMRemoteSettings.html#NM-REMOTE-SETTINGS-BUS:CAPS" title="NM_REMOTE_SETTINGS_BUS">NM_REMOTE_SETTINGS_BUS</a>
#define             <a class="link" href="NMRemoteSettings.html#NM-REMOTE-SETTINGS-SCOPE:CAPS" title="NM_REMOTE_SETTINGS_SCOPE">NM_REMOTE_SETTINGS_SCOPE</a>
#define             <a class="link" href="NMRemoteSettings.html#NM-REMOTE-SETTINGS-SERVICE-RUNNING:CAPS" title="NM_REMOTE_SETTINGS_SERVICE_RUNNING">NM_REMOTE_SETTINGS_SERVICE_RUNNING</a>
                    <a class="link" href="NMRemoteSettings.html#NMRemoteSettings-struct" title="NMRemoteSettings">NMRemoteSettings</a>;
                    <a class="link" href="NMRemoteSettings.html#NMRemoteSettingsClass" title="NMRemoteSettingsClass">NMRemoteSettingsClass</a>;
<a class="link" href="NMRemoteSettings.html" title="NMRemoteSettings"><span class="returnvalue">NMRemoteSettings</span></a> *  <a class="link" href="NMRemoteSettings.html#nm-remote-settings-new" title="nm_remote_settings_new ()">nm_remote_settings_new</a>              (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *bus</code></em>,
                                                         <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/08/NMConnection.html#NMConnectionScope"><span class="type">NMConnectionScope</span></a> scope</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="NMRemoteSettings.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----NMRemoteSettings
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="NMRemoteSettings.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
NMRemoteSettings implements
 <a class="link" href="libnm-glib-NMSettings.html#NMSettingsInterface">NMSettingsInterface</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="NMRemoteSettings.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="NMRemoteSettings.html#NMRemoteSettings--bus" title='The "bus" property'>bus</a>"                      <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a>*      : Read / Write / Construct Only
  "<a class="link" href="NMRemoteSettings.html#NMRemoteSettings--scope" title='The "scope" property'>scope</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only
  "<a class="link" href="NMRemoteSettings.html#NMRemoteSettings--service-running" title='The "service-running" property'>service-running</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
</pre>
</div>
<div class="refsect1" title="Description">
<a name="NMRemoteSettings.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="NMRemoteSettings.details"></a><h2>Details</h2>
<div class="refsect2" title="NM_REMOTE_SETTINGS_BUS">
<a name="NM-REMOTE-SETTINGS-BUS:CAPS"></a><h3>NM_REMOTE_SETTINGS_BUS</h3>
<pre class="programlisting">#define NM_REMOTE_SETTINGS_BUS "bus"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NM_REMOTE_SETTINGS_SCOPE">
<a name="NM-REMOTE-SETTINGS-SCOPE:CAPS"></a><h3>NM_REMOTE_SETTINGS_SCOPE</h3>
<pre class="programlisting">#define NM_REMOTE_SETTINGS_SCOPE "scope"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NM_REMOTE_SETTINGS_SERVICE_RUNNING">
<a name="NM-REMOTE-SETTINGS-SERVICE-RUNNING:CAPS"></a><h3>NM_REMOTE_SETTINGS_SERVICE_RUNNING</h3>
<pre class="programlisting">#define NM_REMOTE_SETTINGS_SERVICE_RUNNING "service-running"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NMRemoteSettings">
<a name="NMRemoteSettings-struct"></a><h3>NMRemoteSettings</h3>
<pre class="programlisting">typedef struct _NMRemoteSettings NMRemoteSettings;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NMRemoteSettingsClass">
<a name="NMRemoteSettingsClass"></a><h3>NMRemoteSettingsClass</h3>
<pre class="programlisting">typedef struct {
	GObjectClass parent;

	/* Padding for future expansion */
	void (*_reserved1) (void);
	void (*_reserved2) (void);
	void (*_reserved3) (void);
	void (*_reserved4) (void);
	void (*_reserved5) (void);
	void (*_reserved6) (void);
} NMRemoteSettingsClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="nm_remote_settings_new ()">
<a name="nm-remote-settings-new"></a><h3>nm_remote_settings_new ()</h3>
<pre class="programlisting"><a class="link" href="NMRemoteSettings.html" title="NMRemoteSettings"><span class="returnvalue">NMRemoteSettings</span></a> *  nm_remote_settings_new              (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *bus</code></em>,
                                                         <em class="parameter"><code><a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/08/NMConnection.html#NMConnectionScope"><span class="type">NMConnectionScope</span></a> scope</code></em>);</pre>
<p>
Creates a new object representing the remote settings service.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a valid and connected D-Bus connection
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scope</code></em> :</span></p></td>
<td>the settings service scope (either user or system)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new remote settings object on success, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="NMRemoteSettings.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "bus" property'>
<a name="NMRemoteSettings--bus"></a><h3>The <code class="literal">"bus"</code> property</h3>
<pre class="programlisting">  "bus"                      <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a>*      : Read / Write / Construct Only</pre>
<p>DBusGConnection.</p>
</div>
<hr>
<div class="refsect2" title='The "scope" property'>
<a name="NMRemoteSettings--scope"></a><h3>The <code class="literal">"scope"</code> property</h3>
<pre class="programlisting">  "scope"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only</pre>
<p>NMConnection scope.</p>
<p>Allowed values: &lt;= 2</p>
<p>Default value: 2</p>
</div>
<hr>
<div class="refsect2" title='The "service-running" property'>
<a name="NMRemoteSettings--service-running"></a><h3>The <code class="literal">"service-running"</code> property</h3>
<pre class="programlisting">  "service-running"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
<p>Is service running.</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>