diff options
| author | Michael Biebl <biebl@debian.org> | 2011-04-08 07:30:59 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2011-04-08 07:30:59 +0200 |
| commit | f75dd6fd1975146623052b843b182dc32c3fbe46 (patch) | |
| tree | 05ba60b772670f038c9a1fbff940ec5d3e28d870 /docs/libnm-util/html/NMConnection.html | |
| parent | c980bdf58dc973dd5617aaa6f9466f9e44fcbf58 (diff) | |
Imported Upstream version 0.8.998 upstream/0.8.998
Diffstat (limited to 'docs/libnm-util/html/NMConnection.html')
| -rw-r--r-- | docs/libnm-util/html/NMConnection.html | 1062 |
1 files changed, 0 insertions, 1062 deletions
diff --git a/docs/libnm-util/html/NMConnection.html b/docs/libnm-util/html/NMConnection.html deleted file mode 100644 index 7d660012..00000000 --- a/docs/libnm-util/html/NMConnection.html +++ /dev/null @@ -1,1062 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMConnection</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> -<link rel="home" href="index.html" title="libnm-util Reference Manual"> -<link rel="up" href="ch01.html" title="libnm-util API Reference"> -<link rel="prev" href="ch01.html" title="libnm-util API Reference"> -<link rel="next" href="NMSetting.html" title="NMSetting"> -<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="ch01.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-util Reference Manual</th> -<td><a accesskey="n" href="NMSetting.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMConnection.synopsis" class="shortcut">Top</a> - | - <a href="#NMConnection.description" class="shortcut">Description</a> - | - <a href="#NMConnection.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMConnection.properties" class="shortcut">Properties</a> - | - <a href="#NMConnection.signals" class="shortcut">Signals</a> -</td></tr> -</table> -<div class="refentry" title="NMConnection"> -<a name="NMConnection"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="NMConnection.top_of_page"></a>NMConnection</span></h2> -<p>NMConnection — Describes a connection to specific network or provider</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv" title="Synopsis"> -<a name="NMConnection.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <nm-connection.h> - -enum <a class="link" href="NMConnection.html#NMConnectionScope" title="enum NMConnectionScope">NMConnectionScope</a>; -enum <a class="link" href="NMConnection.html#NMConnectionError" title="enum NMConnectionError">NMConnectionError</a>; -#define <a class="link" href="NMConnection.html#NM-TYPE-CONNECTION-ERROR:CAPS" title="NM_TYPE_CONNECTION_ERROR">NM_TYPE_CONNECTION_ERROR</a> -#define <a class="link" href="NMConnection.html#NM-CONNECTION-ERROR:CAPS" title="NM_CONNECTION_ERROR">NM_CONNECTION_ERROR</a> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMConnection.html#nm-connection-error-quark" title="nm_connection_error_quark ()">nm_connection_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -#define <a class="link" href="NMConnection.html#NM-CONNECTION-SCOPE:CAPS" title="NM_CONNECTION_SCOPE">NM_CONNECTION_SCOPE</a> -#define <a class="link" href="NMConnection.html#NM-CONNECTION-PATH:CAPS" title="NM_CONNECTION_PATH">NM_CONNECTION_PATH</a> - <a class="link" href="NMConnection.html#NMConnection-struct" title="NMConnection">NMConnection</a>; - <a class="link" href="NMConnection.html#NMConnectionClass" title="NMConnectionClass">NMConnectionClass</a>; -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMConnection.html#nm-connection-get-type" title="nm_connection_get_type ()">nm_connection_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -<a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * <a class="link" href="NMConnection.html#nm-connection-new" title="nm_connection_new ()">nm_connection_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -<a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * <a class="link" href="NMConnection.html#nm-connection-new-from-hash" title="nm_connection_new_from_hash ()">nm_connection_new_from_hash</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *hash</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); -<a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * <a class="link" href="NMConnection.html#nm-connection-duplicate" title="nm_connection_duplicate ()">nm_connection_duplicate</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMConnection.html#nm-connection-add-setting" title="nm_connection_add_setting ()">nm_connection_add_setting</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMConnection.html#nm-connection-remove-setting" title="nm_connection_remove_setting ()">nm_connection_remove_setting</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>); -<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMConnection.html#nm-connection-get-setting" title="nm_connection_get_setting ()">nm_connection_get_setting</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>); -<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMConnection.html#nm-connection-get-setting-by-name" title="nm_connection_get_setting_by_name ()">nm_connection_get_setting_by_name</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMConnection.html#nm-connection-replace-settings" title="nm_connection_replace_settings ()">nm_connection_replace_settings</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *new_settings</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMConnection.html#nm-connection-compare" title="nm_connection_compare ()">nm_connection_compare</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMConnection.html#nm-connection-diff" title="nm_connection_diff ()">nm_connection_diff</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **out_settings</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMConnection.html#nm-connection-verify" title="nm_connection_verify ()">nm_connection_verify</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMConnection.html#nm-connection-need-secrets" title="nm_connection_need_secrets ()">nm_connection_need_secrets</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> **hints</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMConnection.html#nm-connection-clear-secrets" title="nm_connection_clear_secrets ()">nm_connection_clear_secrets</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMConnection.html#nm-connection-update-secrets" title="nm_connection_update_secrets ()">nm_connection_update_secrets</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *setting_name</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *setting_secrets</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMConnection.html#nm-connection-set-scope" title="nm_connection_set_scope ()">nm_connection_set_scope</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a class="link" href="NMConnection.html#NMConnectionScope" title="enum NMConnectionScope"><span class="type">NMConnectionScope</span></a> scope</code></em>); -<a class="link" href="NMConnection.html#NMConnectionScope" title="enum NMConnectionScope"><span class="returnvalue">NMConnectionScope</span></a> <a class="link" href="NMConnection.html#nm-connection-get-scope" title="nm_connection_get_scope ()">nm_connection_get_scope</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMConnection.html#nm-connection-set-path" title="nm_connection_set_path ()">nm_connection_set_path</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMConnection.html#nm-connection-get-path" title="nm_connection_get_path ()">nm_connection_get_path</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMConnection.html#nm-connection-for-each-setting-value" title="nm_connection_for_each_setting_value ()">nm_connection_for_each_setting_value</a> - (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingValueIterFn" title="NMSettingValueIterFn ()"><span class="type">NMSettingValueIterFn</span></a> func</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="NMConnection.html#nm-connection-to-hash" title="nm_connection_to_hash ()">nm_connection_to_hash</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMConnection.html#nm-connection-dump" title="nm_connection_dump ()">nm_connection_dump</a> (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>); -<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMConnection.html#nm-connection-create-setting" title="nm_connection_create_setting ()">nm_connection_create_setting</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>); -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMConnection.html#nm-connection-lookup-setting-type" title="nm_connection_lookup_setting_type ()">nm_connection_lookup_setting_type</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>); -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMConnection.html#nm-connection-lookup-setting-type-by-quark" title="nm_connection_lookup_setting_type_by_quark ()">nm_connection_lookup_setting_type_by_quark</a> - (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> error_quark</code></em>); -</pre> -</div> -<div class="refsect1" title="Object Hierarchy"> -<a name="NMConnection.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> - +----NMConnection -</pre> -</div> -<div class="refsect1" title="Properties"> -<a name="NMConnection.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMConnection.html#NMConnection--path" title='The "path" property'>path</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct - "<a class="link" href="NMConnection.html#NMConnection--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 -</pre> -</div> -<div class="refsect1" title="Signals"> -<a name="NMConnection.signals"></a><h2>Signals</h2> -<pre class="synopsis"> - "<a class="link" href="NMConnection.html#NMConnection-secrets-updated" title='The "secrets-updated" signal'>secrets-updated</a>" : Run First -</pre> -</div> -<div class="refsect1" title="Description"> -<a name="NMConnection.description"></a><h2>Description</h2> -<p> -An <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> describes all the settings and configuration values that -are necessary to configure network devices for operation on a specific -network. Connections are the fundamental operating object for -NetworkManager; no device is connected without a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>, or -disconnected without having been connected with a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>. -</p> -<p> -Each <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> contains a list of <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> objects usually referenced -by name (using <a class="link" href="NMConnection.html#nm-connection-get-setting-by-name" title="nm_connection_get_setting_by_name ()"><code class="function">nm_connection_get_setting_by_name()</code></a>) or by type (with -<a class="link" href="NMConnection.html#nm-connection-get-setting" title="nm_connection_get_setting ()"><code class="function">nm_connection_get_setting()</code></a>). The settings describe the actual parameters -with which the network devices are configured, including device-specific -parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters -(addresses, routes, addressing methods, etc). -</p> -<p> -Most connections also have a <a class="link" href="NMConnection.html#NMConnectionScope" title="enum NMConnectionScope"><code class="literal">NMConnectionScope</code></a>; a connection will be -provided over D-Bus either by the user settings service -(org.freedesktop.NetworkManagerUserSettings) running in an active user -session, or by the system-wide system settings service -(org.freedesktop.NetworkManagerSystemSettings) which provides connections -for all users. -</p> -</div> -<div class="refsect1" title="Details"> -<a name="NMConnection.details"></a><h2>Details</h2> -<div class="refsect2" title="enum NMConnectionScope"> -<a name="NMConnectionScope"></a><h3>enum NMConnectionScope</h3> -<pre class="programlisting">typedef enum { - NM_CONNECTION_SCOPE_UNKNOWN = 0, - NM_CONNECTION_SCOPE_SYSTEM, - NM_CONNECTION_SCOPE_USER -} NMConnectionScope; -</pre> -<p> -Connection scope indicated what settings service, if any, provides the -connection. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><a name="NM-CONNECTION-SCOPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_CONNECTION_SCOPE_UNKNOWN</code></span></p></td> -<td>scope not known or not yet set -</td> -</tr> -<tr> -<td><p><a name="NM-CONNECTION-SCOPE-SYSTEM:CAPS"></a><span class="term"><code class="literal">NM_CONNECTION_SCOPE_SYSTEM</code></span></p></td> -<td>connection is provided by the system settings - service -</td> -</tr> -<tr> -<td><p><a name="NM-CONNECTION-SCOPE-USER:CAPS"></a><span class="term"><code class="literal">NM_CONNECTION_SCOPE_USER</code></span></p></td> -<td>connection is provided by a user settings service -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enum NMConnectionError"> -<a name="NMConnectionError"></a><h3>enum NMConnectionError</h3> -<pre class="programlisting">typedef enum -{ - NM_CONNECTION_ERROR_UNKNOWN = 0, - NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND -} NMConnectionError; -</pre> -<p> -Describes errors that may result from operations involving a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><a name="NM-CONNECTION-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_CONNECTION_ERROR_UNKNOWN</code></span></p></td> -<td>unknown or unclassified error -</td> -</tr> -<tr> -<td><p><a name="NM-CONNECTION-ERROR-CONNECTION-SETTING-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND</code></span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object - did not contain the required <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> object, which must be - present for all connections -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="NM_TYPE_CONNECTION_ERROR"> -<a name="NM-TYPE-CONNECTION-ERROR:CAPS"></a><h3>NM_TYPE_CONNECTION_ERROR</h3> -<pre class="programlisting">#define NM_TYPE_CONNECTION_ERROR (nm_connection_error_get_type ()) -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2" title="NM_CONNECTION_ERROR"> -<a name="NM-CONNECTION-ERROR:CAPS"></a><h3>NM_CONNECTION_ERROR</h3> -<pre class="programlisting">#define NM_CONNECTION_ERROR nm_connection_error_quark () -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2" title="nm_connection_error_quark ()"> -<a name="nm-connection-error-quark"></a><h3>nm_connection_error_quark ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_connection_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Registers an error quark for <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> if necessary. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the error quark used for <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> errors. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="NM_CONNECTION_SCOPE"> -<a name="NM-CONNECTION-SCOPE:CAPS"></a><h3>NM_CONNECTION_SCOPE</h3> -<pre class="programlisting">#define NM_CONNECTION_SCOPE "scope" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2" title="NM_CONNECTION_PATH"> -<a name="NM-CONNECTION-PATH:CAPS"></a><h3>NM_CONNECTION_PATH</h3> -<pre class="programlisting">#define NM_CONNECTION_PATH "path" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2" title="NMConnection"> -<a name="NMConnection-struct"></a><h3>NMConnection</h3> -<pre class="programlisting">typedef struct _NMConnection NMConnection;</pre> -<p> -The NMConnection struct contains only private data. -It should only be accessed through the functions described below. -</p> -</div> -<hr> -<div class="refsect2" title="NMConnectionClass"> -<a name="NMConnectionClass"></a><h3>NMConnectionClass</h3> -<pre class="programlisting">typedef struct { - GObjectClass parent; - - /* Signals */ - void (*secrets_updated) (NMConnection *connection, const char * setting); -} NMConnectionClass; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2" title="nm_connection_get_type ()"> -<a name="nm-connection-get-type"></a><h3>nm_connection_get_type ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> nm_connection_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_new ()"> -<a name="nm-connection-new"></a><h3>nm_connection_new ()</h3> -<pre class="programlisting"><a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * nm_connection_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Creates a new <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object with no <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> objects. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the new empty <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_new_from_hash ()"> -<a name="nm-connection-new-from-hash"></a><h3>nm_connection_new_from_hash ()</h3> -<pre class="programlisting"><a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * nm_connection_new_from_hash (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *hash</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> -<p> -Creates a new <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> from a hash table describing the connection. See -<a class="link" href="NMConnection.html#nm-connection-to-hash" title="nm_connection_to_hash ()"><code class="function">nm_connection_to_hash()</code></a> for a description of the expected hash table. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> describing the connection -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>on unsuccessful return, an error -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the new <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object, populated with settings created -from the values in the hash table, or NULL if the connection failed to -validate -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_duplicate ()"> -<a name="nm-connection-duplicate"></a><h3>nm_connection_duplicate ()</h3> -<pre class="programlisting"><a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * nm_connection_duplicate (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> -<p> -Duplicates a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> to duplicate -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> a new <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> containing the same settings and properties -as the source <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_add_setting ()"> -<a name="nm-connection-add-setting"></a><h3>nm_connection_add_setting ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_connection_add_setting (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> -<p> -Adds a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to the connection, replacing any previous <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> of the -same name which has previously been added to the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>. The -connection takes ownership of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object and does not increase -the setting object's reference count. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to add to the connection object -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_remove_setting ()"> -<a name="nm-connection-remove-setting"></a><h3>nm_connection_remove_setting ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_connection_remove_setting (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>);</pre> -<p> -Removes the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> with the given <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> from the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>. This -operation dereferences the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>setting_type</code></em> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the setting object to remove -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_get_setting ()"> -<a name="nm-connection-get-setting"></a><h3>nm_connection_get_setting ()</h3> -<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_connection_get_setting (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>);</pre> -<p> -Gets the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> with the given <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>, if one has been previously added -to the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>setting_type</code></em> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the setting object to return -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>, or NULL if no setting of that type was previously -added to the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_get_setting_by_name ()"> -<a name="nm-connection-get-setting-by-name"></a><h3>nm_connection_get_setting_by_name ()</h3> -<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_connection_get_setting_by_name (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> -<p> -Gets the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> with the given name, if one has been previously added -the the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>a setting name -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>, or NULL if no setting with that name was previously -added to the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_replace_settings ()"> -<a name="nm-connection-replace-settings"></a><h3>nm_connection_replace_settings ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_connection_replace_settings (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *new_settings</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>new_settings</code></em> :</span></p></td> -<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> of settings -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>location to store error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the settings were valid and added to the connection, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> -if they were not -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_compare ()"> -<a name="nm-connection-compare"></a><h3>nm_connection_compare ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_connection_compare (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>);</pre> -<p> -Compares two <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> objects for similarity, with comparison behavior -modified by a set of flags. See <a class="link" href="NMSetting.html#nm-setting-compare" title="nm_setting_compare ()"><code class="function">nm_setting_compare()</code></a> for a description of -each flag's behavior. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td> -<td>a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td> -<td>a second <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> to compare with the first -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> -<td>compare flags, e.g. <a class="link" href="NMSetting.html#NM-SETTING-COMPARE-FLAG-EXACT:CAPS"><code class="literal">NM_SETTING_COMPARE_FLAG_EXACT</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the comparison succeeds, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it does not -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_diff ()"> -<a name="nm-connection-diff"></a><h3>nm_connection_diff ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_connection_diff (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **out_settings</code></em>);</pre> -<p> -Compares two <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> objects for similarity, with comparison behavior -modified by a set of flags. See <a class="link" href="NMSetting.html#nm-setting-compare" title="nm_setting_compare ()"><code class="function">nm_setting_compare()</code></a> for a description of -each flag's behavior. If the connections differ, settings and keys within -each setting that differ are added to the returned <em class="parameter"><code>out_settings</code></em> hash table. -No values are returned, only key names. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td> -<td>a <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td> -<td>a second <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> to compare with the first -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> -<td>compare flags, e.g. <a class="link" href="NMSetting.html#NM-SETTING-COMPARE-FLAG-EXACT:CAPS"><code class="literal">NM_SETTING_COMPARE_FLAG_EXACT</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>out_settings</code></em> :</span></p></td> -<td>if the connections differ, on return a hash table mapping -setting names to second-level GHashTable, which contains key names that differ -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connections contain the same values, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they do -not -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_verify ()"> -<a name="nm-connection-verify"></a><h3>nm_connection_verify ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_connection_verify (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> -<p> -Validates the connection and all its settings. Each setting's properties -have allowed values, and some values are dependent on other values. For -example, if a WiFi connection is security enabled, the <a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> -setting object's 'security' property must contain the setting name of the -<a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity"><span class="type">NMSettingWirelessSecurity</span></a> object, which must also be present in the -connection for the connection to be valid. As another example, the -<a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> object's 'mac-address' property must be a validly formatted -MAC address. The returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> contains information about which -setting and which property failed validation, and how it failed validation. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> to verify -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>location to store error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection is valid, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is not -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_need_secrets ()"> -<a name="nm-connection-need-secrets"></a><h3>nm_connection_need_secrets ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_connection_need_secrets (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> **hints</code></em>);</pre> -<p> -Returns the name of the first setting object in the connection which would -need secrets to make a successful connection. The returned hints are only -intended as a guide to what secrets may be required, because in some -circumstances, there is no way to conclusively determine exactly which -secrets are needed. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>hints</code></em> :</span></p></td> -<td>the address of a pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>, initialized to NULL, which -on return points to an allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the property names of -secrets of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> which may be required; the caller owns the array -and must free the each array element with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>, as well as the array -itself with <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-free"><code class="function">g_ptr_array_free()</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the setting name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object which has invalid or -missing secrets -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_clear_secrets ()"> -<a name="nm-connection-clear-secrets"></a><h3>nm_connection_clear_secrets ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_connection_clear_secrets (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> -<p> -Clears and frees any secrets that may be stored in the connection, to avoid -keeping secret data in memory when not needed. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_update_secrets ()"> -<a name="nm-connection-update-secrets"></a><h3>nm_connection_update_secrets ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_connection_update_secrets (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *setting_name</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *setting_secrets</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> -<p> -Update the specified setting's secrets, given a hash table of secrets -intended for that setting (deserialized from D-Bus for example). -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>setting_name</code></em> :</span></p></td> -<td>the setting object name to which the secrets apply -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>setting_secrets</code></em> :</span></p></td> -<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> mapping string:<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> of setting property names and -secrets -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>location to store error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the secrets were successfully updated and the connection -is valid, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure or if the setting was never added to the connection -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_set_scope ()"> -<a name="nm-connection-set-scope"></a><h3>nm_connection_set_scope ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_connection_set_scope (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a class="link" href="NMConnection.html#NMConnectionScope" title="enum NMConnectionScope"><span class="type">NMConnectionScope</span></a> scope</code></em>);</pre> -<p> -Sets the scope of the connection. This property is not serialized, and is -only for the reference of the caller. A connection may have no scope -(internal, temporary connections), "system" scope (provided by the system -settings service), or "user" scope, provided by a user settings service. The -creator of the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object is responsible for setting the -connection's scope if needed. Sets the <a class="link" href="NMConnection.html#NMConnection--scope" title='The "scope" property'><span class="type">"scope"</span></a> property. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>scope</code></em> :</span></p></td> -<td>the scope of the connection -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_get_scope ()"> -<a name="nm-connection-get-scope"></a><h3>nm_connection_get_scope ()</h3> -<pre class="programlisting"><a class="link" href="NMConnection.html#NMConnectionScope" title="enum NMConnectionScope"><span class="returnvalue">NMConnectionScope</span></a> nm_connection_get_scope (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> -<p> -Returns the connection scope. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the scope of the connection, previously set by a call to -<a class="link" href="NMConnection.html#nm-connection-set-scope" title="nm_connection_set_scope ()"><code class="function">nm_connection_set_scope()</code></a>. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_set_path ()"> -<a name="nm-connection-set-path"></a><h3>nm_connection_set_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_connection_set_path (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> -<p> -Sets the D-Bus path of the connection. This property is not serialized, and -is only for the reference of the caller. Sets the <a class="link" href="NMConnection.html#NMConnection--path" title='The "path" property'><span class="type">"path"</span></a> -property. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> -<td>the D-Bus path of the connection as given by the settings service -which provides the connection -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_get_path ()"> -<a name="nm-connection-get-path"></a><h3>nm_connection_get_path ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_connection_get_path (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> -<p> -Returns the connection's D-Bus path. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the D-Bus path of the connection, previously set by a call to -<a class="link" href="NMConnection.html#nm-connection-set-path" title="nm_connection_set_path ()"><code class="function">nm_connection_set_path()</code></a>. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_for_each_setting_value ()"> -<a name="nm-connection-for-each-setting-value"></a><h3>nm_connection_for_each_setting_value ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_connection_for_each_setting_value - (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingValueIterFn" title="NMSettingValueIterFn ()"><span class="type">NMSettingValueIterFn</span></a> func</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> -<p> -Iterates over the properties of each <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object in the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>, -calling the supplied user function for each property. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td> -<td>user-supplied function called for each setting's property -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>user data passed to <em class="parameter"><code>func</code></em> at each invocation -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_to_hash ()"> -<a name="nm-connection-to-hash"></a><h3>nm_connection_to_hash ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * nm_connection_to_hash (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> -<p> -Converts the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> into a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> describing the connection, -suitable for marshalling over D-Bus or serializing. The hash table mapping -is string:<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> with each element in the returned hash representing -a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object. The keys are setting object names, and the values -are <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTables</span></a> mapping string:GValue, each of which represents the -properties of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> a new <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> describing the connection, its settings, and -each setting's properties. The caller owns the hash table and must unref -the hash table with <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-unref"><code class="function">g_hash_table_unref()</code></a> when it is no longer needed. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_dump ()"> -<a name="nm-connection-dump"></a><h3>nm_connection_dump ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_connection_dump (<em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> -<p> -Print the connection to stdout. For debugging purposes ONLY, should NOT -be used for serialization of the connection or machine-parsed in any way. The -output format is not guaranteed to be stable and may change at any time. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_create_setting ()"> -<a name="nm-connection-create-setting"></a><h3>nm_connection_create_setting ()</h3> -<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_connection_create_setting (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> -<p> -Create a new <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object of the desired type, given a setting name. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>a setting name -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the new setting object, or NULL if the setting name was unknown -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_lookup_setting_type ()"> -<a name="nm-connection-lookup-setting-type"></a><h3>nm_connection_lookup_setting_type ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> nm_connection_lookup_setting_type (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> -<p> -Returns the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the setting's class for a given setting name. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>a setting name -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the setting's class -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="nm_connection_lookup_setting_type_by_quark ()"> -<a name="nm-connection-lookup-setting-type-by-quark"></a><h3>nm_connection_lookup_setting_type_by_quark ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> nm_connection_lookup_setting_type_by_quark - (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> error_quark</code></em>);</pre> -<p> -Returns the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the setting's class for a given setting error quark. -Useful for figuring out which setting a returned error is for. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>error_quark</code></em> :</span></p></td> -<td>a setting error quark -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the setting's class -</td> -</tr> -</tbody> -</table></div> -</div> -</div> -<div class="refsect1" title="Property Details"> -<a name="NMConnection.property-details"></a><h2>Property Details</h2> -<div class="refsect2" title='The "path" property'> -<a name="NMConnection--path"></a><h3>The <code class="literal">"path"</code> property</h3> -<pre class="programlisting"> "path" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre> -<p> -The connection's D-Bus path, used only by the calling process as a record -of the D-Bus path of the connection as provided by a settings service. -</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2" title='The "scope" property'> -<a name="NMConnection--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</pre> -<p> -The connection's scope, used only by the calling process as a record -of which settings service the connection is provided by. One of the -NM_CONNECTION_SCOPE_* defines. -</p> -<p>Allowed values: <= 2</p> -<p>Default value: 0</p> -</div> -</div> -<div class="refsect1" title="Signal Details"> -<a name="NMConnection.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2" title='The "secrets-updated" signal'> -<a name="NMConnection-secrets-updated"></a><h3>The <code class="literal">"secrets-updated"</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *setting_name, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First</pre> -<p> -The ::secrets-updated signal is emitted when the secrets of a setting -have been changed. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the object on which the signal is emitted -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>setting_name</code></em> :</span></p></td> -<td>the setting name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> for which secrets were -updated -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>user data set when the signal handler was connected.</td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.15</div> -</body> -</html> \ No newline at end of file |