diff options
Diffstat (limited to 'docs/libnm/html/NMSetting.html')
| -rw-r--r-- | docs/libnm/html/NMSetting.html | 1426 |
1 files changed, 782 insertions, 644 deletions
diff --git a/docs/libnm/html/NMSetting.html b/docs/libnm/html/NMSetting.html index 6c7f830b..5e5d535b 100644 --- a/docs/libnm/html/NMSetting.html +++ b/docs/libnm/html/NMSetting.html @@ -2,34 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMSetting</title> +<title>libnm Reference Manual: NMSetting</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm Reference Manual"> <link rel="up" href="ch03.html" title="Connection and Setting API Reference"> <link rel="prev" href="NMSimpleConnection.html" title="NMSimpleConnection"> <link rel="next" href="NMSettingConnection.html" title="NMSettingConnection"> -<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.21 (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="NMSimpleConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch03.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 Reference Manual</th> -<td><a accesskey="n" href="NMSettingConnection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMSetting.synopsis" class="shortcut">Top</a> - | - <a href="#NMSetting.description" class="shortcut">Description</a> - | - <a href="#NMSetting.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMSetting.properties" class="shortcut">Properties</a> -</td></tr> -</table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#NMSetting.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMSetting.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMSetting.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMSimpleConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMSettingConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMSetting"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -37,896 +31,1040 @@ <h2><span class="refentrytitle"><a name="NMSetting.top_of_page"></a>NMSetting</span></h2> <p>NMSetting — Describes related configuration information</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="NMSetting.synopsis"></a><h2>Synopsis</h2> -<a name="NMSettingSecretFlags"></a><a name="NMSettingCompareFlags"></a><a name="NMSettingDiffResult"></a><pre class="synopsis">#define <a class="link" href="NMSetting.html#NM-SETTING-PARAM-REQUIRED:CAPS" title="NM_SETTING_PARAM_REQUIRED">NM_SETTING_PARAM_REQUIRED</a> -#define <a class="link" href="NMSetting.html#NM-SETTING-PARAM-SECRET:CAPS" title="NM_SETTING_PARAM_SECRET">NM_SETTING_PARAM_SECRET</a> -#define <a class="link" href="NMSetting.html#NM-SETTING-PARAM-FUZZY-IGNORE:CAPS" title="NM_SETTING_PARAM_FUZZY_IGNORE">NM_SETTING_PARAM_FUZZY_IGNORE</a> -#define <a class="link" href="NMSetting.html#NM-SETTING-NAME:CAPS" title="NM_SETTING_NAME">NM_SETTING_NAME</a> -enum <a class="link" href="NMSetting.html#NMSettingSecretFlags-enum" title="enum NMSettingSecretFlags">NMSettingSecretFlags</a>; -enum <a class="link" href="NMSetting.html#NMSettingCompareFlags-enum" title="enum NMSettingCompareFlags">NMSettingCompareFlags</a>; -struct <a class="link" href="NMSetting.html#NMSetting-struct" title="struct NMSetting">NMSetting</a>; -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="NMSetting.html#NMSettingClearSecretsWithFlagsFn" title="NMSettingClearSecretsWithFlagsFn ()">*NMSettingClearSecretsWithFlagsFn</a>) (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *secret</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> flags</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 class="link" href="NMSetting.html#NMSettingClass" title="NMSettingClass">NMSettingClass</a>; -<span class="returnvalue">void</span> (<a class="link" href="NMSetting.html#NMSettingValueIterFn" title="NMSettingValueIterFn ()">*NMSettingValueIterFn</a>) (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *key</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</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/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMSetting.html#nm-setting-lookup-type" title="nm_setting_lookup_type ()">nm_setting_lookup_type</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>); -<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSetting.html#nm-setting-duplicate" title="nm_setting_duplicate ()">nm_setting_duplicate</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMSetting.html#nm-setting-get-name" title="nm_setting_get_name ()">nm_setting_get_name</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</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="NMSetting.html#nm-setting-verify" title="nm_setting_verify ()">nm_setting_verify</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><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>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSetting.html#nm-setting-compare" title="nm_setting_compare ()">nm_setting_compare</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>); -enum <a class="link" href="NMSetting.html#NMSettingDiffResult-enum" title="enum NMSettingDiffResult">NMSettingDiffResult</a>; -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()">nm_setting_diff</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> invert_results</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> **results</code></em>); -<span class="returnvalue">void</span> <a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()">nm_setting_enumerate_values</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</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>); -<span class="returnvalue">char</span> * <a class="link" href="NMSetting.html#nm-setting-to-string" title="nm_setting_to_string ()">nm_setting_to_string</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</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="NMSetting.html#nm-setting-get-secret-flags" title="nm_setting_get_secret_flags ()">nm_setting_get_secret_flags</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> *out_flags</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="NMSetting.html#nm-setting-set-secret-flags" title="nm_setting_set_secret_flags ()">nm_setting_set_secret_flags</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> flags</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 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="returnvalue">GVariantType</span></a> * <a class="link" href="NMSetting.html#nm-setting-get-dbus-property-type" title="nm_setting_get_dbus_property_type ()">nm_setting_get_dbus_property_type</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="NMSetting.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - GFlags - +----NMSettingSecretFlags -</pre> -<pre class="synopsis"> - GEnum - +----NMSettingCompareFlags -</pre> -<pre class="synopsis"> - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - +----NMSetting - +----<a class="link" href="NMSetting8021x.html" title="NMSetting8021x">NMSetting8021x</a> - +----<a class="link" href="NMSettingAdsl.html" title="NMSettingAdsl">NMSettingAdsl</a> - +----<a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth">NMSettingBluetooth</a> - +----<a class="link" href="NMSettingBond.html" title="NMSettingBond">NMSettingBond</a> - +----<a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort">NMSettingBridgePort</a> - +----<a class="link" href="NMSettingBridge.html" title="NMSettingBridge">NMSettingBridge</a> - +----<a class="link" href="NMSettingCdma.html" title="NMSettingCdma">NMSettingCdma</a> - +----<a class="link" href="NMSettingConnection.html" title="NMSettingConnection">NMSettingConnection</a> - +----<a class="link" href="NMSettingDcb.html" title="NMSettingDcb">NMSettingDcb</a> - +----<a class="link" href="NMSettingGeneric.html" title="NMSettingGeneric">NMSettingGeneric</a> - +----<a class="link" href="NMSettingGsm.html" title="NMSettingGsm">NMSettingGsm</a> - +----<a class="link" href="NMSettingInfiniband.html" title="NMSettingInfiniband">NMSettingInfiniband</a> - +----<a class="link" href="NMSettingIPConfig.html" title="NMSettingIPConfig">NMSettingIPConfig</a> - +----<a class="link" href="NMSettingOlpcMesh.html" title="NMSettingOlpcMesh">NMSettingOlpcMesh</a> - +----<a class="link" href="NMSettingPpp.html" title="NMSettingPpp">NMSettingPpp</a> - +----<a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe">NMSettingPppoe</a> - +----<a class="link" href="NMSettingSerial.html" title="NMSettingSerial">NMSettingSerial</a> - +----<a class="link" href="NMSettingTeamPort.html" title="NMSettingTeamPort">NMSettingTeamPort</a> - +----<a class="link" href="NMSettingTeam.html" title="NMSettingTeam">NMSettingTeam</a> - +----<a class="link" href="NMSettingVlan.html" title="NMSettingVlan">NMSettingVlan</a> - +----<a class="link" href="NMSettingVpn.html" title="NMSettingVpn">NMSettingVpn</a> - +----<a class="link" href="NMSettingWimax.html" title="NMSettingWimax">NMSettingWimax</a> - +----<a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a> - +----<a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity">NMSettingWirelessSecurity</a> - +----<a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a> -</pre> -<pre class="synopsis"> - GEnum - +----NMSettingDiffResult -</pre> -</div> -<div class="refsect1"> -<a name="NMSetting.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMSetting.html#NMSetting--name" title='The "name" property'>name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read -</pre> -</div> <div class="refsect1"> -<a name="NMSetting.description"></a><h2>Description</h2> -<p> -Each <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> contains properties that describe configuration that applies -to a specific network layer (like IPv4 or IPv6 configuration) or device type -(like Ethernet, or Wi-Fi). A collection of individual settings together -make up an <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a>. Each property is strongly typed and usually has -a number of allowed values. See each <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass for a description -of properties and allowed values. -</p> -</div> -<div class="refsect1"> -<a name="NMSetting.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="NM-SETTING-PARAM-REQUIRED:CAPS"></a><h3>NM_SETTING_PARAM_REQUIRED</h3> -<pre class="programlisting">#define NM_SETTING_PARAM_REQUIRED (1 << (1 + G_PARAM_USER_SHIFT)) -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-SETTING-PARAM-SECRET:CAPS"></a><h3>NM_SETTING_PARAM_SECRET</h3> -<pre class="programlisting">#define NM_SETTING_PARAM_SECRET (1 << (2 + G_PARAM_USER_SHIFT)) -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-SETTING-PARAM-FUZZY-IGNORE:CAPS"></a><h3>NM_SETTING_PARAM_FUZZY_IGNORE</h3> -<pre class="programlisting">#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT)) -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-SETTING-NAME:CAPS"></a><h3>NM_SETTING_NAME</h3> -<pre class="programlisting">#define NM_SETTING_NAME "name" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingSecretFlags-enum"></a><h3>enum NMSettingSecretFlags</h3> -<pre class="programlisting">typedef enum { - /*< flags >*/ - NM_SETTING_SECRET_FLAG_NONE = 0x00000000, - NM_SETTING_SECRET_FLAG_AGENT_OWNED = 0x00000001, - NM_SETTING_SECRET_FLAG_NOT_SAVED = 0x00000002, - NM_SETTING_SECRET_FLAG_NOT_REQUIRED = 0x00000004 - - /* NOTE: if adding flags, update nm-core-internal.h as well */ -} NMSettingSecretFlags; -</pre> -<p> -These flags indicate specific behavior related to handling of a secret. Each -secret has a corresponding set of these flags which indicate how the secret -is to be stored and/or requested when it is needed. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="NMSetting.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="functions_return"> +<col class="functions_name"> </colgroup> <tbody> <tr> -<td><p><a name="NM-SETTING-SECRET-FLAG-NONE:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SECRET_FLAG_NONE</code></span></p></td> -<td>the system is responsible for providing and -storing this secret (default) +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-REQUIRED:CAPS" title="NM_SETTING_PARAM_REQUIRED">NM_SETTING_PARAM_REQUIRED</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-SECRET:CAPS" title="NM_SETTING_PARAM_SECRET">NM_SETTING_PARAM_SECRET</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-PARAM-FUZZY-IGNORE:CAPS" title="NM_SETTING_PARAM_FUZZY_IGNORE">NM_SETTING_PARAM_FUZZY_IGNORE</a></td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="NMSetting.html#NMSettingClearSecretsWithFlagsFn" title="NMSettingClearSecretsWithFlagsFn ()">*NMSettingClearSecretsWithFlagsFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-SECRET-FLAG-AGENT-OWNED:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SECRET_FLAG_AGENT_OWNED</code></span></p></td> -<td>a user secret agent is responsible -for providing and storing this secret; when it is required agents will be -asked to retrieve it +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="NMSetting.html#NMSettingValueIterFn" title="NMSettingValueIterFn ()">*NMSettingValueIterFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-SECRET-FLAG-NOT-SAVED:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SECRET_FLAG_NOT_SAVED</code></span></p></td> -<td>this secret should not be saved, but -should be requested from the user each time it is needed +<td class="function_type"> +<span class="returnvalue">GType</span> +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-lookup-type" title="nm_setting_lookup_type ()">nm_setting_lookup_type</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-SECRET-FLAG-NOT-REQUIRED:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SECRET_FLAG_NOT_REQUIRED</code></span></p></td> -<td>in situations where it cannot be -automatically determined that the secret is required (some VPNs and PPP -providers dont require all secrets) this flag indicates that the specific -secret is not required +<td class="function_type"> +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-duplicate" title="nm_setting_duplicate ()">nm_setting_duplicate</a> <span class="c_punctuation">()</span> </td> </tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingCompareFlags-enum"></a><h3>enum NMSettingCompareFlags</h3> -<pre class="programlisting">typedef enum { - NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000, - NM_SETTING_COMPARE_FLAG_FUZZY = 0x00000001, - NM_SETTING_COMPARE_FLAG_IGNORE_ID = 0x00000002, - NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS = 0x00000004, - NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS = 0x00000008, - NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS = 0x00000010, - NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT = 0x00000020, - NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT = 0x00000040, - NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP = 0x00000080, - - /* 0x80000000 is used for a private flag */ -} NMSettingCompareFlags; -</pre> -<p> -These flags modify the comparison behavior when comparing two settings or -two connections. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-EXACT:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_EXACT</code></span></p></td> -<td>match all properties exactly +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-get-name" title="nm_setting_get_name ()">nm_setting_get_name</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-FUZZY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_FUZZY</code></span></p></td> -<td>match only important attributes, like SSID, - type, security settings, etc. Does not match, for example, connection ID - or UUID. +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-verify" title="nm_setting_verify ()">nm_setting_verify</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-ID:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_IGNORE_ID</code></span></p></td> -<td>ignore the connection's ID +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-compare" title="nm_setting_compare ()">nm_setting_compare</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-SECRETS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS</code></span></p></td> -<td>ignore all secrets +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()">nm_setting_diff</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-AGENT-OWNED-SECRETS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS</code></span></p></td> -<td>ignore secrets for which - the secret's flags indicate the secret is owned by a user secret agent - (ie, the secret's flag includes <em class="parameter"><code>NM_SETTING_SECRET_FLAG_AGENT_OWNED</code></em>) +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()">nm_setting_enumerate_values</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-NOT-SAVED-SECRETS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS</code></span></p></td> -<td>ignore secrets for which - the secret's flags indicate the secret should not be saved to persistent - storage (ie, the secret's flag includes <em class="parameter"><code>NM_SETTING_SECRET_FLAG_NOT_SAVED</code></em>) +<td class="function_type"> +<span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-to-string" title="nm_setting_to_string ()">nm_setting_to_string</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-DIFF-RESULT-WITH-DEFAULT:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></span></p></td> -<td>if this flag is set, - <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> and <a class="link" href="libnm-NMConnection.html#nm-connection-diff" title="nm_connection_diff ()"><code class="function">nm_connection_diff()</code></a> will also include properties that - are set to their default value. See also <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT</code></em>. +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-get-secret-flags" title="nm_setting_get_secret_flags ()">nm_setting_get_secret_flags</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-DIFF-RESULT-NO-DEFAULT:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT</code></span></p></td> -<td>if this flag is set, - <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> and <a class="link" href="libnm-NMConnection.html#nm-connection-diff" title="nm_connection_diff ()"><code class="function">nm_connection_diff()</code></a> will not include properties that - are set to their default value. This is the opposite of - <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em>. If both flags are set together, - <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em> wins. If both flags are unset, - this means to exclude default properties if there is a setting to compare, - but include all properties, if the setting 'b' is missing. This is the legacy - behaviour of libnm-util, where <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> behaved differently depending - on whether the setting 'b' was available. If <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em> - is set, <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> will also set the flags <em class="parameter"><code>NM_SETTING_DIFF_RESULT_IN_A_DEFAULT</code></em> - and <em class="parameter"><code>NM_SETTING_DIFF_RESULT_IN_B_DEFAULT</code></em>, if the values are default values. +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-set-secret-flags" title="nm_setting_set_secret_flags ()">nm_setting_set_secret_flags</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-TIMESTAMP:CAPS"></a><span class="term"><code class="literal">NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP</code></span></p></td> -<td>ignore the connection's timestamp +<td class="function_type">const <span class="returnvalue">GVariantType</span> * +</td> +<td class="function_name"> +<a class="link" href="NMSetting.html#nm-setting-get-dbus-property-type" title="nm_setting_get_dbus_property_type ()">nm_setting_get_dbus_property_type</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="NMSetting-struct"></a><h3>struct NMSetting</h3> -<pre class="programlisting">struct NMSetting;</pre> -<p> -The NMSetting struct contains only private data. -It should only be accessed through the functions described below. -</p> +<div class="refsect1"> +<a name="NMSetting.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMSetting.html#NMSetting--name" title="The “name” property">name</a></td> +<td class="property_flags">Read</td> +</tr></tbody> +</table></div> </div> -<hr> -<div class="refsect2"> -<a name="NMSettingClearSecretsWithFlagsFn"></a><h3>NMSettingClearSecretsWithFlagsFn ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*NMSettingClearSecretsWithFlagsFn) (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *secret</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> flags</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> -<div class="variablelist"><table border="0" class="variablelist"> +<div class="refsect1"> +<a name="NMSetting.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="name"> +<col class="description"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> -<td>The setting for which secrets are being iterated</td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting.html#NM-SETTING-NAME:CAPS" title="NM_SETTING_NAME">NM_SETTING_NAME</a></td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td> -<td>The secret's name</td> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags">NMSettingSecretFlags</a></td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> -<td>The secret's flags, eg <a class="link" href="NMSetting.html#NM-SETTING-SECRET-FLAG-AGENT-OWNED:CAPS"><code class="literal">NM_SETTING_SECRET_FLAG_AGENT_OWNED</code></a> -</td> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags">NMSettingCompareFlags</a></td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>User data passed to <a class="link" href="libnm-NMConnection.html#nm-connection-clear-secrets-with-flags" title="nm_connection_clear_secrets_with_flags ()"><code class="function">nm_connection_clear_secrets_with_flags()</code></a> -</td> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="NMSetting.html#NMSetting-struct" title="struct NMSetting">NMSetting</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> to clear the secret, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to not clear the secret</td> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="NMSetting.html#NMSettingDiffResult" title="enum NMSettingDiffResult">NMSettingDiffResult</a></td> </tr> </tbody> </table></div> </div> +<div class="refsect1"> +<a name="NMSetting.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> + <span class="lineart">├──</span> NMSettingCompareFlags + <span class="lineart">╰──</span> NMSettingDiffResult + <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> + <span class="lineart">╰──</span> NMSettingSecretFlags + GObject + <span class="lineart">╰──</span> NMSetting + <span class="lineart">├──</span> <a class="link" href="NMSetting8021x.html" title="NMSetting8021x">NMSetting8021x</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingAdsl.html" title="NMSettingAdsl">NMSettingAdsl</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth">NMSettingBluetooth</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingBond.html" title="NMSettingBond">NMSettingBond</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort">NMSettingBridgePort</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingBridge.html" title="NMSettingBridge">NMSettingBridge</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingCdma.html" title="NMSettingCdma">NMSettingCdma</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingConnection.html" title="NMSettingConnection">NMSettingConnection</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingDcb.html" title="NMSettingDcb">NMSettingDcb</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingGeneric.html" title="NMSettingGeneric">NMSettingGeneric</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingGsm.html" title="NMSettingGsm">NMSettingGsm</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingInfiniband.html" title="NMSettingInfiniband">NMSettingInfiniband</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingIPConfig.html" title="NMSettingIPConfig">NMSettingIPConfig</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingOlpcMesh.html" title="NMSettingOlpcMesh">NMSettingOlpcMesh</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingPpp.html" title="NMSettingPpp">NMSettingPpp</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingPppoe.html" title="NMSettingPppoe">NMSettingPppoe</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingSerial.html" title="NMSettingSerial">NMSettingSerial</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingTeamPort.html" title="NMSettingTeamPort">NMSettingTeamPort</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingTeam.html" title="NMSettingTeam">NMSettingTeam</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingVlan.html" title="NMSettingVlan">NMSettingVlan</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingVpn.html" title="NMSettingVpn">NMSettingVpn</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingWimax.html" title="NMSettingWimax">NMSettingWimax</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a> + <span class="lineart">├──</span> <a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity">NMSettingWirelessSecurity</a> + <span class="lineart">╰──</span> <a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a> +</pre> +</div> +<div class="refsect1"> +<a name="NMSetting.description"></a><h2>Description</h2> +<p>Each <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> contains properties that describe configuration that applies +to a specific network layer (like IPv4 or IPv6 configuration) or device type +(like Ethernet, or Wi-Fi). A collection of individual settings together +make up an <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a>. Each property is strongly typed and usually has +a number of allowed values. See each <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass for a description +of properties and allowed values.</p> +</div> +<div class="refsect1"> +<a name="NMSetting.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="NM-SETTING-PARAM-REQUIRED:CAPS"></a><h3>NM_SETTING_PARAM_REQUIRED</h3> +<pre class="programlisting">#define NM_SETTING_PARAM_REQUIRED (1 << (1 + G_PARAM_USER_SHIFT)) +</pre> +<p> +</p> +</div> <hr> <div class="refsect2"> -<a name="NMSettingClass"></a><h3>NMSettingClass</h3> -<pre class="programlisting">typedef struct { - GObjectClass parent; - - /* Virtual functions */ - gint (*verify) (NMSetting *setting, - NMConnection *connection, - GError **error); - - GPtrArray *(*need_secrets) (NMSetting *setting); - - int (*update_one_secret) (NMSetting *setting, - const char *key, - GVariant *value, - GError **error); - - gboolean (*get_secret_flags) (NMSetting *setting, - const char *secret_name, - gboolean verify_secret, - NMSettingSecretFlags *out_flags, - GError **error); - - gboolean (*set_secret_flags) (NMSetting *setting, - const char *secret_name, - gboolean verify_secret, - NMSettingSecretFlags flags, - GError **error); - - gboolean (*clear_secrets_with_flags) (NMSetting *setting, - GParamSpec *pspec, - NMSettingClearSecretsWithFlagsFn func, - gpointer user_data); - - /* Returns TRUE if the given property contains the same value in both settings */ - gboolean (*compare_property) (NMSetting *setting, - NMSetting *other, - const GParamSpec *prop_spec, - NMSettingCompareFlags flags); -} NMSettingClass; +<a name="NM-SETTING-PARAM-SECRET:CAPS"></a><h3>NM_SETTING_PARAM_SECRET</h3> +<pre class="programlisting">#define NM_SETTING_PARAM_SECRET (1 << (2 + G_PARAM_USER_SHIFT)) +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-PARAM-FUZZY-IGNORE:CAPS"></a><h3>NM_SETTING_PARAM_FUZZY_IGNORE</h3> +<pre class="programlisting">#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT)) </pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="NMSettingValueIterFn"></a><h3>NMSettingValueIterFn ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> (*NMSettingValueIterFn) (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *key</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</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> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="NMSettingClearSecretsWithFlagsFn"></a><h3>NMSettingClearSecretsWithFlagsFn ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +<span class="c_punctuation">(</span>*NMSettingClearSecretsWithFlagsFn<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *secret</code></em>, + <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> flags</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.4.8.5.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> -<td>The setting for which properties are being iterated, given to -<a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()"><code class="function">nm_setting_enumerate_values()</code></a> -</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>The setting for which secrets are being iterated</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> -<td>The value/property name</td> +<td class="parameter_name"><p>secret</p></td> +<td class="parameter_description"><p>The secret's name</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>The property's value</td> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>The secret's flags, eg <a class="link" href="NMSetting.html#NM-SETTING-SECRET-FLAG-AGENT-OWNED:CAPS"><code class="literal">NM_SETTING_SECRET_FLAG_AGENT_OWNED</code></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> -<td>The property's flags, like <a class="link" href="NMSetting.html#NM-SETTING-PARAM-SECRET:CAPS" title="NM_SETTING_PARAM_SECRET"><code class="literal">NM_SETTING_PARAM_SECRET</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>User data passed to <a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()"><code class="function">nm_setting_enumerate_values()</code></a> -</td> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>User data passed to <a class="link" href="libnm-NMConnection.html#nm-connection-clear-secrets-with-flags" title="nm_connection_clear_secrets_with_flags ()"><code class="function">nm_connection_clear_secrets_with_flags()</code></a></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.5.5"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> to clear the secret, <code class="literal">FALSE</code> to not clear the secret</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-lookup-type"></a><h3>nm_setting_lookup_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_setting_lookup_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" class="variablelist"> +<a name="NMSettingValueIterFn"></a><h3>NMSettingValueIterFn ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*NMSettingValueIterFn<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *key</code></em>, + <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>, + <em class="parameter"><code><span class="type">GParamFlags</span> flags</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.4.8.6.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>a setting name</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>The setting for which properties are being iterated, given to +<a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()"><code class="function">nm_setting_enumerate_values()</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>key</p></td> +<td class="parameter_description"><p>The value/property name</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The property's value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>The property's flags, like <a class="link" href="NMSetting.html#NM-SETTING-PARAM-SECRET:CAPS" title="NM_SETTING_PARAM_SECRET"><code class="literal">NM_SETTING_PARAM_SECRET</code></a></p></td> +<td class="parameter_annotations"> </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, or <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-INVALID:CAPS"><code class="literal">G_TYPE_INVALID</code></a> if -<em class="parameter"><code>name</code></em> is not recognized.</td> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>User data passed to <a class="link" href="NMSetting.html#nm-setting-enumerate-values" title="nm_setting_enumerate_values ()"><code class="function">nm_setting_enumerate_values()</code></a></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-duplicate"></a><h3>nm_setting_duplicate ()</h3> -<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_duplicate (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> -<p> -Duplicates a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-lookup-type"></a><h3>nm_setting_lookup_type ()</h3> +<pre class="programlisting"><span class="returnvalue">GType</span> +nm_setting_lookup_type (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p>Returns the <span class="type">GType</span> of the setting's class for a given setting name.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> -<tbody> -<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 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="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> containing the same properties and values as the -source <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> -</td> -</tr> -</tbody> +<tbody><tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>a setting name</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.7.6"></a><h4>Returns</h4> +<p> the <span class="type">GType</span> of the setting's class, or <code class="literal">G_TYPE_INVALID</code> if +<em class="parameter"><code>name</code></em> +is not recognized.</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-get-name"></a><h3>nm_setting_get_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_get_name (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> -<p> -Returns the type name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-duplicate"></a><h3>nm_setting_duplicate ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +nm_setting_duplicate (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> +<p>Duplicates a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> -<tbody> -<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> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a string containing the type name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object, -like 'ppp' or 'wireless' or 'wired'.</td> -</tr> -</tbody> +<tbody><tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to duplicate</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.8.6"></a><h4>Returns</h4> +<p> a new <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> containing the same properties and values as the +source <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-verify"></a><h3>nm_setting_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_setting_verify (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><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 setting. Each setting's properties have allowed values, and -some are dependent on other values (hence the need for <em class="parameter"><code>connection</code></em>). 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 property of the setting -failed validation, and in what way that property failed validation. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-get-name"></a><h3>nm_setting_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_get_name (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> +<p>Returns the type name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object</p> +<div class="refsect3"> +<a name="id-1.4.4.8.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.4.8.9.6"></a><h4>Returns</h4> +<p> a string containing the type name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object, +like 'ppp' or 'wireless' or 'wired'.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-verify"></a><h3>nm_setting_verify ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_setting_verify (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>Validates the setting. Each setting's properties have allowed values, and +some are dependent on other values (hence the need for <em class="parameter"><code>connection</code></em> +). The +returned <span class="type">GError</span> contains information about which property of the setting +failed validation, and in what way that property failed validation.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <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 verify</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to verify</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>the <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> that <em class="parameter"><code>setting</code></em> came from, or -<a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>setting</code></em> is being verified in isolation. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> -</td> +<td class="parameter_name"><p>connection</p></td> +<td class="parameter_description"><p> the <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> that <em class="parameter"><code>setting</code></em> +came from, or +<code class="literal">NULL</code> if <em class="parameter"><code>setting</code></em> +is being verified in isolation. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></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="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.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 setting 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> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>location to store error, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.10.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if the setting is valid, <code class="literal">FALSE</code> if it is not</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-compare"></a><h3>nm_setting_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_setting_compare (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>);</pre> -<p> -Compares two <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> objects for similarity, with comparison behavior -modified by a set of flags. See the documentation for <a class="link" href="NMSetting.html#NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> -for a description of each flag's behavior. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-compare"></a><h3>nm_setting_compare ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_setting_compare (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *a</code></em>, + <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</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="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> objects for similarity, with comparison behavior +modified by a set of flags. See the documentation for <a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> +for a description of each flag's behavior.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td> -<td>a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> -</td> +<td class="parameter_name"><p>a</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </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="NMSetting.html" title="NMSetting"><span class="type">NMSetting</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> +<td class="parameter_name"><p>b</p></td> +<td class="parameter_description"><p>a second <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to compare with the first</p></td> +<td class="parameter_annotations"> </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> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>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></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.11.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if the comparison succeeds, <code class="literal">FALSE</code> if it does not</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="NMSettingDiffResult-enum"></a><h3>enum NMSettingDiffResult</h3> -<pre class="programlisting">typedef enum { - NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000, - NM_SETTING_DIFF_RESULT_IN_A = 0x00000001, - NM_SETTING_DIFF_RESULT_IN_B = 0x00000002, - NM_SETTING_DIFF_RESULT_IN_A_DEFAULT = 0x00000004, - NM_SETTING_DIFF_RESULT_IN_B_DEFAULT = 0x00000004, -} NMSettingDiffResult; -</pre> -<p> -These values indicate the result of a setting difference operation. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-diff"></a><h3>nm_setting_diff ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_setting_diff (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *a</code></em>, + <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</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><span class="type">gboolean</span> invert_results</code></em>, + <em class="parameter"><code><span class="type">GHashTable</span> **results</code></em>);</pre> +<p>Compares two <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> objects for similarity, with comparison behavior +modified by a set of flags. See the documentation for <a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> +for a description of each flag's behavior. If the settings differ, the keys +of each setting that differ from the other are added to <em class="parameter"><code>results</code></em> +, mapped to +one or more <a class="link" href="NMSetting.html#NMSettingDiffResult" title="enum NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a> values.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.12.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><a name="NM-SETTING-DIFF-RESULT-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_DIFF_RESULT_UNKNOWN</code></span></p></td> -<td>unknown result -</td> +<td class="parameter_name"><p>a</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><a name="NM-SETTING-DIFF-RESULT-IN-A:CAPS"></a><span class="term"><code class="literal">NM_SETTING_DIFF_RESULT_IN_A</code></span></p></td> -<td>the property is present in setting A -</td> +<td class="parameter_name"><p>b</p></td> +<td class="parameter_description"><p>a second <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to compare with the first</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><a name="NM-SETTING-DIFF-RESULT-IN-B:CAPS"></a><span class="term"><code class="literal">NM_SETTING_DIFF_RESULT_IN_B</code></span></p></td> -<td>the property is present in setting B -</td> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>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></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><a name="NM-SETTING-DIFF-RESULT-IN-A-DEFAULT:CAPS"></a><span class="term"><code class="literal">NM_SETTING_DIFF_RESULT_IN_A_DEFAULT</code></span></p></td> -<td>the property is present in -setting A but is set to the default value. This flag is only set, -if you specify <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em>. -</td> +<td class="parameter_name"><p>invert_results</p></td> +<td class="parameter_description"><p>this parameter is used internally by libnm and should +be set to <code class="literal">FALSE</code>. If <code class="literal">TRUE</code> inverts the meaning of the <a class="link" href="NMSetting.html#NMSettingDiffResult" title="enum NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><a name="NM-SETTING-DIFF-RESULT-IN-B-DEFAULT:CAPS"></a><span class="term"><code class="literal">NM_SETTING_DIFF_RESULT_IN_B_DEFAULT</code></span></p></td> -<td>analog to <em class="parameter"><code>NM_SETTING_DIFF_RESULT_IN_A_DEFAULT</code></em>. -</td> +<td class="parameter_name"><p>results</p></td> +<td class="parameter_description"><p> if the +settings differ, on return a hash table mapping the differing keys to one or +more <a class="link" href="NMSetting.html#NMSettingDiffResult" title="enum NMSettingDiffResult"><code class="literal">NMSettingDiffResult</code></a> values OR-ed together. If the settings do not +differ, any hash table passed in is unmodified. If no hash table is passed +in and the settings differ, a new one is created and returned. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 guint32]</span></td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.12.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if the settings contain the same values, <code class="literal">FALSE</code> if they do not</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-diff"></a><h3>nm_setting_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_setting_diff (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *a</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *b</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> invert_results</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> **results</code></em>);</pre> -<p> -Compares two <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> objects for similarity, with comparison behavior -modified by a set of flags. See the documentation for <a class="link" href="NMSetting.html#NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> -for a description of each flag's behavior. If the settings differ, the keys -of each setting that differ from the other are added to <em class="parameter"><code>results</code></em>, mapped to -one or more <a class="link" href="NMSetting.html#NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a> values. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-enumerate-values"></a><h3>nm_setting_enumerate_values ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_setting_enumerate_values (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</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><span class="type">gpointer</span> user_data</code></em>);</pre> +<p>Iterates over each property of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object, calling the supplied +user function for each property.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.13.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td> -<td>a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> -</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </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="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to compare with the first</td> +<td class="parameter_name"><p>func</p></td> +<td class="parameter_description"><p> user-supplied function called for each property of the setting. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></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> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data passed to <em class="parameter"><code>func</code></em> +at each invocation</p></td> +<td class="parameter_annotations"> </td> </tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-to-string"></a><h3>nm_setting_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * +nm_setting_to_string (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> +<p>Convert the setting into a string. For debugging purposes ONLY, should NOT +be used for serialization of the setting, or machine-parsed in any way. The +output format is not guaranteed to be stable and may change at any time.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.14.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.4.8.14.6"></a><h4>Returns</h4> +<p> an allocated string containing a textual representation of the +setting's properties and values (including secrets!), which the caller should +free with <code class="function">g_free()</code></p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-get-secret-flags"></a><h3>nm_setting_get_secret_flags ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_setting_get_secret_flags (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, + <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> *out_flags</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>For a given secret, retrieves the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> describing how to +handle that secret.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.15.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>invert_results</code></em> :</span></p></td> -<td>this parameter is used internally by libnm and should -be set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> inverts the meaning of the <a class="link" href="NMSetting.html#NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a>.</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td> -<td>if the -settings differ, on return a hash table mapping the differing keys to one or -more <a class="link" href="NMSetting.html#NMSettingDiffResult"><code class="literal">NMSettingDiffResult</code></a> values OR-ed together. If the settings do not -differ, any hash table passed in is unmodified. If no hash table is passed -in and the settings differ, a new one is created and returned. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 guint32]</span> -</td> +<td class="parameter_name"><p>secret_name</p></td> +<td class="parameter_description"><p>the secret key name to get flags for</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>out_flags</p></td> +<td class="parameter_description"><p>on success, the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> for the secret</p></td> +<td class="parameter_annotations"> </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 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> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>location to store error, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.15.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> on success (if the given secret name was a valid property of +this setting, and if that property is secret), <code class="literal">FALSE</code> if not</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-enumerate-values"></a><h3>nm_setting_enumerate_values ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_enumerate_values (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</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 each property of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object, calling the supplied -user function for each property. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-setting-set-secret-flags"></a><h3>nm_setting_set_secret_flags ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_setting_set_secret_flags (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, + <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> flags</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>For a given secret, stores the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> describing how to +handle that secret.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.16.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <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> -</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </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 property of the setting. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span> -</td> +<td class="parameter_name"><p>secret_name</p></td> +<td class="parameter_description"><p>the secret key name to set flags for</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> for the secret</p></td> +<td class="parameter_annotations"> </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> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>location to store error, or <code class="literal">NULL</code></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.8.16.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> on success (if the given secret name was a valid property of +this setting, and if that property is secret), <code class="literal">FALSE</code> if not</p> +<p></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-to-string"></a><h3>nm_setting_to_string ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * nm_setting_to_string (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> -<p> -Convert the setting into a string. For debugging purposes ONLY, should NOT -be used for serialization of the setting, 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" class="variablelist"> +<a name="nm-setting-get-dbus-property-type"></a><h3>nm_setting_get_dbus_property_type ()</h3> +<pre class="programlisting">const <span class="returnvalue">GVariantType</span> * +nm_setting_get_dbus_property_type (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);</pre> +<p>Gets the D-Bus marshalling type of a property. <em class="parameter"><code>property_name</code></em> + is a D-Bus +property name, which may not necessarily be a <span class="type">GObject</span> property.</p> +<div class="refsect3"> +<a name="id-1.4.4.8.17.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <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> -</td> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>an <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an allocated string containing a textual representation of the -setting's properties and values (including secrets!), which the caller should -free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> -</td> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>the property of <em class="parameter"><code>setting</code></em> +to get the type of</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> -<hr> +<div class="refsect3"> +<a name="id-1.4.4.8.17.6"></a><h4>Returns</h4> +<p> the D-Bus marshalling type of <em class="parameter"><code>property</code></em> +on <em class="parameter"><code>setting</code></em> +.</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="NMSetting.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="nm-setting-get-secret-flags"></a><h3>nm_setting_get_secret_flags ()</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_setting_get_secret_flags (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> *out_flags</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> +<a name="NM-SETTING-NAME:CAPS"></a><h3>NM_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_NAME "name" +</pre> <p> -For a given secret, retrieves the <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> describing how to -handle that secret. </p> -<div class="variablelist"><table border="0" class="variablelist"> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSecretFlags"></a><h3>enum NMSettingSecretFlags</h3> +<p>These flags indicate specific behavior related to handling of a secret. Each +secret has a corresponding set of these flags which indicate how the secret +is to be stored and/or requested when it is needed.</p> +<div class="refsect3"> +<a name="id-1.4.4.9.3.4"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> </colgroup> <tbody> <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> +<td class="enum_member_name"><p><a name="NM-SETTING-SECRET-FLAG-NONE:CAPS"></a>NM_SETTING_SECRET_FLAG_NONE</p></td> +<td class="enum_member_description"> +<p>the system is responsible for providing and +storing this secret (default)</p> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>secret_name</code></em> :</span></p></td> -<td>the secret key name to get flags for</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>out_flags</code></em> :</span></p></td> -<td>on success, the <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> for the secret</td> +<td class="enum_member_name"><p><a name="NM-SETTING-SECRET-FLAG-AGENT-OWNED:CAPS"></a>NM_SETTING_SECRET_FLAG_AGENT_OWNED</p></td> +<td class="enum_member_description"> +<p>a user secret agent is responsible +for providing and storing this secret; when it is required agents will be +asked to retrieve it</p> +</td> +<td class="enum_member_annotations"> </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="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> +<td class="enum_member_name"><p><a name="NM-SETTING-SECRET-FLAG-NOT-SAVED:CAPS"></a>NM_SETTING_SECRET_FLAG_NOT_SAVED</p></td> +<td class="enum_member_description"> +<p>this secret should not be saved, but +should be requested from the user each time it is needed</p> </td> +<td class="enum_member_annotations"> </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> on success (if the given secret name was a valid property of -this setting, and if that property is secret), <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not</td> +<td class="enum_member_name"><p><a name="NM-SETTING-SECRET-FLAG-NOT-REQUIRED:CAPS"></a>NM_SETTING_SECRET_FLAG_NOT_REQUIRED</p></td> +<td class="enum_member_description"> +<p>in situations where it cannot be +automatically determined that the secret is required (some VPNs and PPP +providers dont require all secrets) this flag indicates that the specific +secret is not required</p> +</td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-set-secret-flags"></a><h3>nm_setting_set_secret_flags ()</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_setting_set_secret_flags (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *secret_name</code></em>, - <em class="parameter"><code><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> flags</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> -For a given secret, stores the <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> describing how to -handle that secret. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="NMSettingCompareFlags"></a><h3>enum NMSettingCompareFlags</h3> +<p>These flags modify the comparison behavior when comparing two settings or +two connections.</p> +<div class="refsect3"> +<a name="id-1.4.4.9.4.4"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> </colgroup> <tbody> <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> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-EXACT:CAPS"></a>NM_SETTING_COMPARE_FLAG_EXACT</p></td> +<td class="enum_member_description"> +<p>match all properties exactly</p> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>secret_name</code></em> :</span></p></td> -<td>the secret key name to set flags for</td> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-FUZZY:CAPS"></a>NM_SETTING_COMPARE_FLAG_FUZZY</p></td> +<td class="enum_member_description"> +<p>match only important attributes, like SSID, + type, security settings, etc. Does not match, for example, connection ID + or UUID.</p> +</td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> -<td>the <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> for the secret</td> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-ID:CAPS"></a>NM_SETTING_COMPARE_FLAG_IGNORE_ID</p></td> +<td class="enum_member_description"> +<p>ignore the connection's ID</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-SECRETS:CAPS"></a>NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS</p></td> +<td class="enum_member_description"> +<p>ignore all secrets</p> +</td> +<td class="enum_member_annotations"> </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="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-AGENT-OWNED-SECRETS:CAPS"></a>NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS</p></td> +<td class="enum_member_description"> +<p>ignore secrets for which + the secret's flags indicate the secret is owned by a user secret agent + (ie, the secret's flag includes <em class="parameter"><code>NM_SETTING_SECRET_FLAG_AGENT_OWNED</code></em> +)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-NOT-SAVED-SECRETS:CAPS"></a>NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS</p></td> +<td class="enum_member_description"> +<p>ignore secrets for which + the secret's flags indicate the secret should not be saved to persistent + storage (ie, the secret's flag includes <em class="parameter"><code>NM_SETTING_SECRET_FLAG_NOT_SAVED</code></em> +)</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-DIFF-RESULT-WITH-DEFAULT:CAPS"></a>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</p></td> +<td class="enum_member_description"> +<p>if this flag is set, + <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> and <a class="link" href="libnm-NMConnection.html#nm-connection-diff" title="nm_connection_diff ()"><code class="function">nm_connection_diff()</code></a> will also include properties that + are set to their default value. See also <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT</code></em> +.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-DIFF-RESULT-NO-DEFAULT:CAPS"></a>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT</p></td> +<td class="enum_member_description"> +<p>if this flag is set, + <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> and <a class="link" href="libnm-NMConnection.html#nm-connection-diff" title="nm_connection_diff ()"><code class="function">nm_connection_diff()</code></a> will not include properties that + are set to their default value. This is the opposite of + <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em> +. If both flags are set together, + <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em> + wins. If both flags are unset, + this means to exclude default properties if there is a setting to compare, + but include all properties, if the setting 'b' is missing. This is the legacy + behaviour of libnm-util, where <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> behaved differently depending + on whether the setting 'b' was available. If <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em> + + is set, <a class="link" href="NMSetting.html#nm-setting-diff" title="nm_setting_diff ()"><code class="function">nm_setting_diff()</code></a> will also set the flags <em class="parameter"><code>NM_SETTING_DIFF_RESULT_IN_A_DEFAULT</code></em> + + and <em class="parameter"><code>NM_SETTING_DIFF_RESULT_IN_B_DEFAULT</code></em> +, if the values are default values.</p> </td> +<td class="enum_member_annotations"> </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> on success (if the given secret name was a valid property of -this setting, and if that property is secret), <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not</td> +<td class="enum_member_name"><p><a name="NM-SETTING-COMPARE-FLAG-IGNORE-TIMESTAMP:CAPS"></a>NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP</p></td> +<td class="enum_member_description"> +<p>ignore the connection's timestamp</p> +</td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="nm-setting-get-dbus-property-type"></a><h3>nm_setting_get_dbus_property_type ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="returnvalue">GVariantType</span></a> * nm_setting_get_dbus_property_type (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);</pre> -<p> -Gets the D-Bus marshalling type of a property. <em class="parameter"><code>property_name</code></em> is a D-Bus -property name, which may not necessarily be a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> property. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="NMSetting-struct"></a><h3>struct NMSetting</h3> +<pre class="programlisting">struct NMSetting;</pre> +<p>The NMSetting struct contains only private data. +It should only be accessed through the functions described below.</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingDiffResult"></a><h3>enum NMSettingDiffResult</h3> +<p>These values indicate the result of a setting difference operation.</p> +<div class="refsect3"> +<a name="id-1.4.4.9.6.4"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> -<td>an <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> +<td class="enum_member_name"><p><a name="NM-SETTING-DIFF-RESULT-UNKNOWN:CAPS"></a>NM_SETTING_DIFF_RESULT_UNKNOWN</p></td> +<td class="enum_member_description"> +<p>unknown result</p> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td> -<td>the property of <em class="parameter"><code>setting</code></em> to get the type of</td> +<td class="enum_member_name"><p><a name="NM-SETTING-DIFF-RESULT-IN-A:CAPS"></a>NM_SETTING_DIFF_RESULT_IN_A</p></td> +<td class="enum_member_description"> +<p>the property is present in setting A</p> +</td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the D-Bus marshalling type of <em class="parameter"><code>property</code></em> on <em class="parameter"><code>setting</code></em>.</td> +<td class="enum_member_name"><p><a name="NM-SETTING-DIFF-RESULT-IN-B:CAPS"></a>NM_SETTING_DIFF_RESULT_IN_B</p></td> +<td class="enum_member_description"> +<p>the property is present in setting B</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-SETTING-DIFF-RESULT-IN-A-DEFAULT:CAPS"></a>NM_SETTING_DIFF_RESULT_IN_A_DEFAULT</p></td> +<td class="enum_member_description"> +<p>the property is present in +setting A but is set to the default value. This flag is only set, +if you specify <em class="parameter"><code>NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT</code></em> +.</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-SETTING-DIFF-RESULT-IN-B-DEFAULT:CAPS"></a>NM_SETTING_DIFF_RESULT_IN_B_DEFAULT</p></td> +<td class="enum_member_description"> +<p>analog to <em class="parameter"><code>NM_SETTING_DIFF_RESULT_IN_A_DEFAULT</code></em> +.</p> +</td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> </div> +</div> <div class="refsect1"> <a name="NMSetting.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMSetting--name"></a><h3>The <code class="literal">"name"</code> property</h3> -<pre class="programlisting"> "name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> -<p> -The setting's name, which uniquely identifies the setting within the +<a name="NMSetting--name"></a><h3>The <code class="literal">“name”</code> property</h3> +<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre> +<p>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for -example "ppp" or "wireless" or "wired". -</p> +example "ppp" or "wireless" or "wired".</p> +<p>Flags: Read</p> <p>Default value: NULL</p> </div> </div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.19</div> + Generated by GTK-Doc V1.21</div> </body> </html> \ No newline at end of file |