diff options
Diffstat (limited to 'docs/libnm-util/html/NMSetting.html')
| -rw-r--r-- | docs/libnm-util/html/NMSetting.html | 381 |
1 files changed, 117 insertions, 264 deletions
diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html index c77c5985..77129d21 100644 --- a/docs/libnm-util/html/NMSetting.html +++ b/docs/libnm-util/html/NMSetting.html @@ -6,15 +6,15 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> -<link rel="prev" href="ch01.html" title="libnm-util API Reference"> +<link rel="prev" href="NMConnection.html" title="NMConnection"> <link rel="next" href="NMSettingConnection.html" title="NMSettingConnection"> -<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> <tr valign="middle"> -<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="NMConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">libnm-util Reference Manual</th> @@ -30,7 +30,7 @@ <a href="#NMSetting.properties" class="shortcut">Properties</a> </td></tr> </table> -<div class="refentry"> +<div class="refentry" title="NMSetting"> <a name="NMSetting"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> @@ -39,12 +39,12 @@ </td> <td valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> +<div class="refsynopsisdiv" title="Synopsis"> <a name="NMSetting.synopsis"></a><h2>Synopsis</h2> -<a name="NMSettingError"></a><pre class="synopsis"> +<pre class="synopsis"> #include <nm-setting.h> -enum <a class="link" href="NMSetting.html#NMSettingError">NMSettingError</a>; +enum <a class="link" href="NMSetting.html#NMSettingError" title="enum NMSettingError">NMSettingError</a>; #define <a class="link" href="NMSetting.html#NM-TYPE-SETTING-ERROR:CAPS" title="NM_TYPE_SETTING_ERROR">NM_TYPE_SETTING_ERROR</a> #define <a class="link" href="NMSetting.html#NM-SETTING-ERROR:CAPS" title="NM_SETTING_ERROR">NM_SETTING_ERROR</a> <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMSetting.html#nm-setting-error-quark" title="nm_setting_error_quark ()">nm_setting_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); @@ -53,7 +53,6 @@ enum <a class="link" href="NMSetting.html#NMSettingError">NMSetti #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" title="enum NMSettingSecretFlags">NMSettingSecretFlags</a>; <a class="link" href="NMSetting.html#NMSetting-struct" title="NMSetting">NMSetting</a>; <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>, @@ -62,9 +61,7 @@ enum <a class="link" href="NMSetting.html#NMSettingSecretFlags" t <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-get-type" title="nm_setting_get_type ()">nm_setting_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -enum <a class="link" href="NMSetting.html#NMSettingHashFlags" title="enum NMSettingHashFlags">NMSettingHashFlags</a>; -<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="NMSetting.html#nm-setting-to-hash" title="nm_setting_to_hash ()">nm_setting_to_hash</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#NMSettingHashFlags" title="enum NMSettingHashFlags"><span class="type">NMSettingHashFlags</span></a> flags</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="NMSetting.html#nm-setting-to-hash" title="nm_setting_to_hash ()">nm_setting_to_hash</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>); <a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSetting.html#nm-setting-new-from-hash" title="nm_setting_new_from_hash ()">nm_setting_new_from_hash</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *hash</code></em>); <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>); @@ -91,23 +88,11 @@ enum <a class="link" href="NMSetting.html#NMSettingDiffResult" ti <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-update-secrets" title="nm_setting_update_secrets ()">nm_setting_update_secrets</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="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *secrets</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); -<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" title="enum 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" title="enum 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> </div> -<div class="refsect1"> +<div class="refsect1" title="Object Hierarchy"> <a name="NMSetting.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> - GEnum - +----NMSettingError -</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> @@ -122,32 +107,31 @@ enum <a class="link" href="NMSetting.html#NMSettingDiffResult" ti +----<a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE">NMSettingPPPOE</a> +----<a class="link" href="NMSettingSerial.html" title="NMSettingSerial">NMSettingSerial</a> +----<a class="link" href="NMSettingVPN.html" title="NMSettingVPN">NMSettingVPN</a> - +----NMSettingWimax +----<a class="link" href="NMSettingWired.html" title="NMSettingWired">NMSettingWired</a> +----<a class="link" href="NMSettingWireless.html" title="NMSettingWireless">NMSettingWireless</a> +----<a class="link" href="NMSettingWirelessSecurity.html" title="NMSettingWirelessSecurity">NMSettingWirelessSecurity</a> </pre> </div> -<div class="refsect1"> +<div class="refsect1" title="Properties"> <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 / Write </pre> </div> -<div class="refsect1"> +<div class="refsect1" title="Description"> <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 WiFi). A collection of individual settings together -make up an <span class="type">NMConnection</span>. Each property is strongly typed and usually has +make up an <a class="link" href="NMConnection.html" title="NMConnection"><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"> +<div class="refsect1" title="Details"> <a name="NMSetting.details"></a><h2>Details</h2> -<div class="refsect2"> +<div class="refsect2" title="enum NMSettingError"> <a name="NMSettingError"></a><h3>enum NMSettingError</h3> <pre class="programlisting">typedef enum { @@ -191,7 +175,7 @@ Describes errors that may result from operations involving a <a class="link" hre </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NM_TYPE_SETTING_ERROR"> <a name="NM-TYPE-SETTING-ERROR:CAPS"></a><h3>NM_TYPE_SETTING_ERROR</h3> <pre class="programlisting">#define NM_TYPE_SETTING_ERROR (nm_setting_error_get_type ()) </pre> @@ -199,7 +183,7 @@ Describes errors that may result from operations involving a <a class="link" hre </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NM_SETTING_ERROR"> <a name="NM-SETTING-ERROR:CAPS"></a><h3>NM_SETTING_ERROR</h3> <pre class="programlisting">#define NM_SETTING_ERROR nm_setting_error_quark () </pre> @@ -207,7 +191,7 @@ Describes errors that may result from operations involving a <a class="link" hre </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_error_quark ()"> <a name="nm-setting-error-quark"></a><h3>nm_setting_error_quark ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> @@ -217,12 +201,13 @@ Registers an error quark for <a class="link" href="NMSetting.html" title="NMSett <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the error quark used for NMSetting errors.</td> +<td> the error quark used for NMSetting errors. +</td> </tr></tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NM_SETTING_PARAM_SERIALIZE"> <a name="NM-SETTING-PARAM-SERIALIZE:CAPS"></a><h3>NM_SETTING_PARAM_SERIALIZE</h3> <pre class="programlisting">#define NM_SETTING_PARAM_SERIALIZE (1 << (0 + G_PARAM_USER_SHIFT)) </pre> @@ -230,7 +215,7 @@ Registers an error quark for <a class="link" href="NMSetting.html" title="NMSett </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NM_SETTING_PARAM_REQUIRED"> <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> @@ -238,7 +223,7 @@ Registers an error quark for <a class="link" href="NMSetting.html" title="NMSett </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NM_SETTING_PARAM_SECRET"> <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> @@ -246,7 +231,7 @@ Registers an error quark for <a class="link" href="NMSetting.html" title="NMSett </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NM_SETTING_PARAM_FUZZY_IGNORE"> <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> @@ -254,7 +239,7 @@ Registers an error quark for <a class="link" href="NMSetting.html" title="NMSett </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NM_SETTING_NAME"> <a name="NM-SETTING-NAME:CAPS"></a><h3>NM_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_NAME "name" </pre> @@ -262,57 +247,7 @@ Registers an error quark for <a class="link" href="NMSetting.html" title="NMSett </p> </div> <hr> -<div class="refsect2"> -<a name="NMSettingSecretFlags"></a><h3>enum NMSettingSecretFlags</h3> -<pre class="programlisting">typedef enum { - 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-setting-private.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"> -<col align="left" valign="top"> -<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> -</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> -</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> -</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> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> +<div class="refsect2" title="NMSetting"> <a name="NMSetting-struct"></a><h3>NMSetting</h3> <pre class="programlisting">typedef struct _NMSetting NMSetting;</pre> <p> @@ -321,7 +256,7 @@ It should only be accessed through the functions described below. </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NMSettingClass"> <a name="NMSettingClass"></a><h3>NMSettingClass</h3> <pre class="programlisting">typedef struct { GObjectClass parent; @@ -338,18 +273,6 @@ It should only be accessed through the functions described below. GValue *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); - /* Padding for future expansion */ void (*_reserved1) (void); void (*_reserved2) (void); @@ -361,7 +284,7 @@ It should only be accessed through the functions described below. </p> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="NMSettingValueIterFn ()"> <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>, @@ -370,53 +293,56 @@ It should only be accessed through the functions described below. <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> </p> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-get-type"></a><h3>nm_setting_get_type ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> nm_setting_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingHashFlags"></a><h3>enum NMSettingHashFlags</h3> -<pre class="programlisting">typedef enum { - NM_SETTING_HASH_FLAG_ALL = 0x00000000, - NM_SETTING_HASH_FLAG_NO_SECRETS = 0x00000001, - NM_SETTING_HASH_FLAG_ONLY_SECRETS = 0x00000002, -} NMSettingHashFlags; -</pre> -<p> -These flags determine which properties are added to the resulting hash -when calling <a class="link" href="NMSetting.html#nm-setting-to-hash" title="nm_setting_to_hash ()"><code class="function">nm_setting_to_hash()</code></a>. -</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> -<td><p><a name="NM-SETTING-HASH-FLAG-ALL:CAPS"></a><span class="term"><code class="literal">NM_SETTING_HASH_FLAG_ALL</code></span></p></td> -<td>hash all properties (including secrets) +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td> </td> </tr> <tr> -<td><p><a name="NM-SETTING-HASH-FLAG-NO-SECRETS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_HASH_FLAG_NO_SECRETS</code></span></p></td> -<td>do not include secrets +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td> </td> </tr> <tr> -<td><p><a name="NM-SETTING-HASH-FLAG-ONLY-SECRETS:CAPS"></a><span class="term"><code class="literal">NM_SETTING_HASH_FLAG_ONLY_SECRETS</code></span></p></td> -<td>only hash secrets +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td> </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_get_type ()"> +<a name="nm-setting-get-type"></a><h3>nm_setting_get_type ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> nm_setting_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_to_hash ()"> <a name="nm-setting-to-hash"></a><h3>nm_setting_to_hash ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * nm_setting_to_hash (<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#NMSettingHashFlags" title="enum NMSettingHashFlags"><span class="type">NMSettingHashFlags</span></a> flags</code></em>);</pre> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * nm_setting_to_hash (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> <p> Converts the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> into a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> mapping each setting property name to a GValue describing that property, suitable for marshalling over @@ -431,20 +357,15 @@ D-Bus or serializing. The mapping is string:GValue. </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> -<td>hash flags, e.g. <a class="link" href="NMSetting.html#NM-SETTING-HASH-FLAG-ALL:CAPS"><code class="literal">NM_SETTING_HASH_FLAG_ALL</code></a> -</td> -</tr> -<tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> describing the setting's properties. <span class="annotation">[<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 GObject.Value]</span> +<td> a new <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> describing the setting's properties </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_new_from_hash ()"> <a name="nm-setting-new-from-hash"></a><h3>nm_setting_new_from_hash ()</h3> <pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_new_from_hash (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *hash</code></em>);</pre> @@ -461,23 +382,26 @@ property names and value types. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>setting_type</code></em> :</span></p></td> -<td>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> type which the hash contains properties for</td> +<td>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> type which the hash contains properties for +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td> <td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> containing a string:GValue mapping of properties -that apply to the setting</td> +that apply to the setting +</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> object populated with the properties from the -hash table, or NULL on failure</td> +<td> a new <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object populated with the properties from the +hash table, or NULL on failure +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_duplicate ()"> <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> @@ -488,19 +412,20 @@ Duplicates a <a class="link" href="NMSetting.html" title="NMSetting"><span class <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> +<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> 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> </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_get_name ()"> <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> @@ -516,14 +441,15 @@ Returns the type name of the <a class="link" href="NMSetting.html" title="NMSett </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> +<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> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_verify ()"> <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="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *all_settings</code></em>, @@ -539,12 +465,14 @@ failed validation, and in what way that property failed validation. <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>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> to verify +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>all_settings</code></em> :</span></p></td> <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of all settings in the connection from which <em class="parameter"><code>setting</code></em> -came</td> +came +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> @@ -553,14 +481,14 @@ came</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> <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> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="enum NMSettingCompareFlags"> <a name="NMSettingCompareFlags"></a><h3>enum NMSettingCompareFlags</h3> <pre class="programlisting">typedef enum { NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000, @@ -602,7 +530,7 @@ two connections. </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_compare ()"> <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>, @@ -622,7 +550,8 @@ for a description of each flag's behavior. </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>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> @@ -631,14 +560,14 @@ for a description of each flag's behavior. </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> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the comparison succeeds, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it does not +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="enum NMSettingDiffResult"> <a name="NMSettingDiffResult"></a><h3>enum NMSettingDiffResult</h3> <pre class="programlisting">typedef enum { NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000, @@ -671,7 +600,7 @@ These values indicate the result of a setting difference operation. </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_diff ()"> <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>, @@ -695,7 +624,8 @@ one or more <a class="link" href="NMSetting.html#NMSettingDiffResult" title="enu </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>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> @@ -705,11 +635,12 @@ one or more <a class="link" href="NMSetting.html#NMSettingDiffResult" title="enu <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-util 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" title="enum NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a>.</td> +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" title="enum NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></a>. +</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 +<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" title="enum NMSettingDiffResult"><span class="type">NMSettingDiffResult</span></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, a new one is created. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 guint32]</span> @@ -717,14 +648,14 @@ in is unmodified. If no hash table is passed in, a new one is created. <span cl </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> <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> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_enumerate_values ()"> <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>, @@ -743,18 +674,19 @@ user function for each property. </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>user-supplied function called for each property of the setting </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>user data passed to <em class="parameter"><code>func</code></em> at each invocation +</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_to_string ()"> <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> @@ -772,7 +704,7 @@ output format is not guaranteed to be stable and may change at any time. </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 +<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> @@ -781,7 +713,7 @@ free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allo </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_clear_secrets ()"> <a name="nm-setting-clear-secrets"></a><h3>nm_setting_clear_secrets ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> nm_setting_clear_secrets (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> <p> @@ -799,7 +731,7 @@ leakage of information. </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_need_secrets ()"> <a name="nm-setting-need-secrets"></a><h3>nm_setting_need_secrets ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * nm_setting_need_secrets (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>);</pre> <p> @@ -818,17 +750,17 @@ is no way to conclusively determine exactly which secrets are needed. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the property names of secrets of the +<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the property names of secrets of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> which may be required; the caller owns the array and must free the each array element with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>, as well as the array -itself with <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-free"><code class="function">g_ptr_array_free()</code></a>. <span class="annotation">[<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]</span> +itself with <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-free"><code class="function">g_ptr_array_free()</code></a> </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2"> +<div class="refsect2" title="nm_setting_update_secrets ()"> <a name="nm-setting-update-secrets"></a><h3>nm_setting_update_secrets ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_setting_update_secrets (<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="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *secrets</code></em>, @@ -848,106 +780,27 @@ setting (deserialized from D-Bus for example). <tr> <td><p><span class="term"><em class="parameter"><code>secrets</code></em> :</span></p></td> <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> mapping string:<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> of setting property names and -secrets</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>location to store error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +secrets </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the secrets were successfully updated and the connection -is valid, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure or if the setting was never added to the connection</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<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" title="enum 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> -<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="variablelist"><table border="0"> -<col align="left" valign="top"> -<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"><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" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> for the secret</td> -</tr> -<tr> <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> <td>location to store error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not</td> -</tr> -</tbody> -</table></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" title="enum 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, 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="variablelist"><table border="0"> -<col align="left" valign="top"> -<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"><em class="parameter"><code>secret_name</code></em> :</span></p></td> -<td>the secret key name to set flags for</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" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> for the secret</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>location to store error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the secrets were successfully updated and the connection +is valid, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure or if the setting was never added to the connection </td> </tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not</td> -</tr> </tbody> </table></div> </div> </div> -<div class="refsect1"> +<div class="refsect1" title="Property Details"> <a name="NMSetting.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> +<div class="refsect2" title='The "name" property'> <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 / Write</pre> <p> @@ -961,6 +814,6 @@ example 'ppp' or 'wireless' or 'wired'. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.17</div> + Generated by GTK-Doc V1.15</div> </body> </html> \ No newline at end of file |