diff options
Diffstat (limited to 'docs/libnm-util/html/NMSetting.html')
| -rw-r--r-- | docs/libnm-util/html/NMSetting.html | 725 |
1 files changed, 725 insertions, 0 deletions
diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html new file mode 100644 index 00000000..181ee2df --- /dev/null +++ b/docs/libnm-util/html/NMSetting.html @@ -0,0 +1,725 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSetting</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libnm-util Reference Manual"> +<link rel="up" href="ch01.html" title="libnm-util API Reference"> +<link rel="prev" href="NMConnection.html" title="NMConnection"> +<link rel="next" href="NMSettingConnection.html" title="NMSettingConnection"> +<meta name="generator" content="GTK-Doc V1.14 (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="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> +<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> +<div class="refentry" title="NMSetting"> +<a name="NMSetting"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<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> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="NMSetting.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <nm-setting.h> + +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="/usr/share/gtk-doc/html/glib/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>); +#define <a class="link" href="NMSetting.html#NM-SETTING-PARAM-SERIALIZE:CAPS" title="NM_SETTING_PARAM_SERIALIZE">NM_SETTING_PARAM_SERIALIZE</a> +#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> + <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>, + <em class="parameter"><code>const <span class="type">char</span> *key</code></em>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); +<a href="/usr/share/gtk-doc/html/gobject/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>); +<a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/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>); +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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *all_settings</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); +enum <a class="link" href="NMSetting.html#NMSettingCompareFlags" title="enum NMSettingCompareFlags">NMSettingCompareFlags</a>; +<a href="/usr/share/gtk-doc/html/glib/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" title="enum NMSettingCompareFlags"><span class="type">NMSettingCompareFlags</span></a> flags</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="/usr/share/gtk-doc/html/glib/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>); +<span class="returnvalue">void</span> <a class="link" href="NMSetting.html#nm-setting-clear-secrets" title="nm_setting_clear_secrets ()">nm_setting_clear_secrets</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>); +<a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="NMSetting.html#nm-setting-need-secrets" title="nm_setting_need_secrets ()">nm_setting_need_secrets</a> (<em class="parameter"><code><a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> *setting</code></em>); +<a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *secrets</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="NMSetting.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----NMSetting + +----<a class="link" href="NMSetting8021x.html" title="NMSetting8021x">NMSetting8021x</a> + +----<a class="link" href="NMSettingBluetooth.html" title="NMSettingBluetooth">NMSettingBluetooth</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="NMSettingGsm.html" title="NMSettingGsm">NMSettingGsm</a> + +----<a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config">NMSettingIP4Config</a> + +----<a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config">NMSettingIP6Config</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="NMSettingVPN.html" title="NMSettingVPN">NMSettingVPN</a> + +----<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" 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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write +</pre> +</div> +<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 <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" title="Details"> +<a name="NMSetting.details"></a><h2>Details</h2> +<div class="refsect2" title="enum NMSettingError"> +<a name="NMSettingError"></a><h3>enum NMSettingError</h3> +<pre class="programlisting">typedef enum +{ + NM_SETTING_ERROR_UNKNOWN = 0, + NM_SETTING_ERROR_PROPERTY_NOT_FOUND, + NM_SETTING_ERROR_PROPERTY_NOT_SECRET, + NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH +} NMSettingError; +</pre> +<p> +Describes errors that may result from operations involving a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="NM-SETTING-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-ERROR-PROPERTY-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">NM_SETTING_ERROR_PROPERTY_NOT_FOUND</code></span></p></td> +<td>a property required by the operation + was not found; for example, an attempt to update an invalid secret +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-ERROR-PROPERTY-NOT-SECRET:CAPS"></a><span class="term"><code class="literal">NM_SETTING_ERROR_PROPERTY_NOT_SECRET</code></span></p></td> +<td>an operation which requires a secret + was attempted on a non-secret property +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-ERROR-PROPERTY-TYPE-MISMATCH:CAPS"></a><span class="term"><code class="literal">NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH</code></span></p></td> +<td>the operation requires a property + of a specific type, or the value couldn't be transformed to the same type + as the property being acted upon +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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> +<p> +</p> +</div> +<hr> +<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> +<p> +</p> +</div> +<hr> +<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="/usr/share/gtk-doc/html/glib/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> +Registers an error quark for <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> if necessary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the error quark used for NMSetting errors. +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<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> +<p> +</p> +</div> +<hr> +<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> +<p> +</p> +</div> +<hr> +<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> +<p> +</p> +</div> +<hr> +<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> +<p> +</p> +</div> +<hr> +<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> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NMSetting"> +<a name="NMSetting-struct"></a><h3>NMSetting</h3> +<pre class="programlisting">typedef struct _NMSetting 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" title="NMSettingClass"> +<a name="NMSettingClass"></a><h3>NMSettingClass</h3> +<pre class="programlisting">typedef struct { + GObjectClass parent; + + /* Virtual functions */ + gboolean (*verify) (NMSetting *setting, + GSList *all_settings, + GError **error); + + GPtrArray *(*need_secrets) (NMSetting *setting); + + gboolean (*update_one_secret) (NMSetting *setting, + const char *key, + GValue *value, + GError **error); + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingClass; +</pre> +<p> +</p> +</div> +<hr> +<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>, + <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p> +</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> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<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" title="nm_setting_get_type ()"> +<a name="nm-setting-get-type"></a><h3>nm_setting_get_type ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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 +D-Bus or serializing. The mapping is string:GValue. +</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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a new <a href="/usr/share/gtk-doc/html/glib/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" 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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> setting_type</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *hash</code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object and populates that object with the properties +contained in the hash table, using each hash key as the property to set, +and each hash value as the value to set that property to. Setting properties +are strongly typed, thus the GValue type of the hash value must be correct. +See the documentation on each <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object subclass for the correct +property names and value types. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td> +<td>the <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> containing a string:GValue mapping of properties +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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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> +Duplicates a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>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> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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> +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"> +<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"><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> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_verify ()"> +<a name="nm-setting-verify"></a><h3>nm_setting_verify ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *all_settings</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/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>all_settings</code></em>). The +returned <a href="/usr/share/gtk-doc/html/glib/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"> +<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> 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="/usr/share/gtk-doc/html/glib/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> +</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/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the setting is valid, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is not +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="enum NMSettingCompareFlags"> +<a name="NMSettingCompareFlags"></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 +} NMSettingCompareFlags; +</pre> +<p> +These flags modify the comparison behavior when comparing two settings or +two connections. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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> +</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> +</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> +</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 secrets +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_compare ()"> +<a name="nm-setting-compare"></a><h3>nm_setting_compare ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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" 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="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td> +<td>a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td> +<td>a second <a class="link" href="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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the comparison succeeds, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it does not +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_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>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/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"> +<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>func</code></em> :</span></p></td> +<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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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> +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"> +<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"><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="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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> +Resets and clears any secrets in the setting. Secrets should be added to the +setting only when needed, and cleared immediately after use to prevent +leakage of information. +</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></tbody> +</table></div> +</div> +<hr> +<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="/usr/share/gtk-doc/html/glib/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> +Returns an array of property names for each secret which may be required +to make a successful connection. The returned hints are only intended as a +guide to what secrets may be required, because in some circumstances, there +is no way to conclusively determine exactly which secrets are needed. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>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 <a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>, as well as the array +itself with <a href="/usr/share/gtk-doc/html/glib/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" title="nm_setting_update_secrets ()"> +<a name="nm-setting-update-secrets"></a><h3>nm_setting_update_secrets ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *secrets</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p> +Update the setting's secrets, given a hash table of secrets intended for that +setting (deserialized from D-Bus for example). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>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>secrets</code></em> :</span></p></td> +<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> mapping string:<a href="/usr/share/gtk-doc/html/gobject/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="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> <a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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> +</div> +<div class="refsect1" title="Property Details"> +<a name="NMSetting.property-details"></a><h2>Property Details</h2> +<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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</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> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.14</div> +</body> +</html> \ No newline at end of file |