diff options
| author | Michael Biebl <biebl@debian.org> | 2011-05-04 21:35:41 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2011-05-04 21:35:41 +0200 |
| commit | 9f806e97a24bba61417ae312fcc0da40914266fb (patch) | |
| tree | 4a25723414ceac11b4cba0558aa16f6f4b459f4b /docs/libnm-util/html/NMSettingConnection.html | |
| parent | 8baa1aca8dfd35e3190d7d5655eb83b5b901e263 (diff) | |
Imported Upstream version 0.8.999 upstream/0.8.999
Diffstat (limited to 'docs/libnm-util/html/NMSettingConnection.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingConnection.html | 336 |
1 files changed, 272 insertions, 64 deletions
diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html index b84ed1bf..27c30ebd 100644 --- a/docs/libnm-util/html/NMSettingConnection.html +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSetting.html" title="NMSetting"> <link rel="next" href="NMSettingWired.html" title="NMSettingWired"> -<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -30,7 +30,7 @@ <a href="#NMSettingConnection.properties" class="shortcut">Properties</a> </td></tr> </table> -<div class="refentry" title="NMSettingConnection"> +<div class="refentry"> <a name="NMSettingConnection"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> @@ -39,13 +39,13 @@ </td> <td valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv" title="Synopsis"> +<div class="refsynopsisdiv"> <a name="NMSettingConnection.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> +<a name="NMSettingConnectionError"></a><pre class="synopsis"> #include <nm-setting-connection.h> #define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-SETTING-NAME:CAPS" title="NM_SETTING_CONNECTION_SETTING_NAME">NM_SETTING_CONNECTION_SETTING_NAME</a> -enum <a class="link" href="NMSettingConnection.html#NMSettingConnectionError" title="enum NMSettingConnectionError">NMSettingConnectionError</a>; +enum <a class="link" href="NMSettingConnection.html#NMSettingConnectionError">NMSettingConnectionError</a>; #define <a class="link" href="NMSettingConnection.html#NM-TYPE-SETTING-CONNECTION-ERROR:CAPS" title="NM_TYPE_SETTING_CONNECTION_ERROR">NM_TYPE_SETTING_CONNECTION_ERROR</a> #define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-ERROR:CAPS" title="NM_SETTING_CONNECTION_ERROR">NM_SETTING_CONNECTION_ERROR</a> <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMSettingConnection.html#nm-setting-connection-error-quark" title="nm_setting_connection_error_quark ()">nm_setting_connection_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); @@ -55,6 +55,7 @@ enum <a class="link" href="NMSettingConnection.html#NMSettingConn #define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-AUTOCONNECT:CAPS" title="NM_SETTING_CONNECTION_AUTOCONNECT">NM_SETTING_CONNECTION_AUTOCONNECT</a> #define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-TIMESTAMP:CAPS" title="NM_SETTING_CONNECTION_TIMESTAMP">NM_SETTING_CONNECTION_TIMESTAMP</a> #define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-READ-ONLY:CAPS" title="NM_SETTING_CONNECTION_READ_ONLY">NM_SETTING_CONNECTION_READ_ONLY</a> +#define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-PERMISSIONS:CAPS" title="NM_SETTING_CONNECTION_PERMISSIONS">NM_SETTING_CONNECTION_PERMISSIONS</a> <a class="link" href="NMSettingConnection.html#NMSettingConnection-struct" title="NMSettingConnection">NMSettingConnection</a>; <a class="link" href="NMSettingConnection.html#NMSettingConnectionClass" title="NMSettingConnectionClass">NMSettingConnectionClass</a>; <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-type" title="nm_setting_connection_get_type ()">nm_setting_connection_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); @@ -67,39 +68,63 @@ const <span class="returnvalue">char</span> * <a class="link" href="NMSet (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-timestamp" title="nm_setting_connection_get_timestamp ()">nm_setting_connection_get_timestamp</a> (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-read-only" title="nm_setting_connection_get_read_only ()">nm_setting_connection_get_read_only</a> (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-num-permissions" title="nm_setting_connection_get_num_permissions ()">nm_setting_connection_get_num_permissions</a> + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-permission" title="nm_setting_connection_get_permission ()">nm_setting_connection_get_permission</a> + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> **out_ptype</code></em>, + <em class="parameter"><code>const <span class="type">char</span> **out_pitem</code></em>, + <em class="parameter"><code>const <span class="type">char</span> **out_detail</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="NMSettingConnection.html#nm-setting-connection-permissions-user-allowed" title="nm_setting_connection_permissions_user_allowed ()">nm_setting_connection_permissions_user_allowed</a> + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *uname</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="NMSettingConnection.html#nm-setting-connection-add-permission" title="nm_setting_connection_add_permission ()">nm_setting_connection_add_permission</a> + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *ptype</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *pitem</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *detail</code></em>); +<span class="returnvalue">void</span> <a class="link" href="NMSettingConnection.html#nm-setting-connection-remove-permission" title="nm_setting_connection_remove_permission ()">nm_setting_connection_remove_permission</a> + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>); </pre> </div> -<div class="refsect1" title="Object Hierarchy"> +<div class="refsect1"> <a name="NMSettingConnection.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> + GEnum + +----NMSettingConnectionError +</pre> +<pre class="synopsis"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> +----<a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> +----NMSettingConnection </pre> </div> -<div class="refsect1" title="Properties"> +<div class="refsect1"> <a name="NMSettingConnection.properties"></a><h2>Properties</h2> <pre class="synopsis"> "<a class="link" href="NMSettingConnection.html#NMSettingConnection--autoconnect" title='The "autoconnect" property'>autoconnect</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct "<a class="link" href="NMSettingConnection.html#NMSettingConnection--id" title='The "id" property'>id</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="NMSettingConnection.html#NMSettingConnection--permissions" title='The "permissions" property'>permissions</a>" <span class="type">GSList_gchararray_</span>* : Read / Write "<a class="link" href="NMSettingConnection.html#NMSettingConnection--read-only" title='The "read-only" property'>read-only</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct "<a class="link" href="NMSettingConnection.html#NMSettingConnection--timestamp" title='The "timestamp" property'>timestamp</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read / Write / Construct "<a class="link" href="NMSettingConnection.html#NMSettingConnection--type" title='The "type" property'>type</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write "<a class="link" href="NMSettingConnection.html#NMSettingConnection--uuid" title='The "uuid" property'>uuid</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" title="Description"> +<div class="refsect1"> <a name="NMSettingConnection.description"></a><h2>Description</h2> <p> The <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes -properties that apply to all <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> objects, regardless of what type -of network connection they describe. Each <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object must contain +properties that apply to all <span class="type">NMConnection</span> objects, regardless of what type +of network connection they describe. Each <span class="type">NMConnection</span> object must contain a <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> setting. </p> </div> -<div class="refsect1" title="Details"> +<div class="refsect1"> <a name="NMSettingConnection.details"></a><h2>Details</h2> -<div class="refsect2" title="NM_SETTING_CONNECTION_SETTING_NAME"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-SETTING-NAME:CAPS"></a><h3>NM_SETTING_CONNECTION_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_SETTING_NAME "connection" </pre> @@ -107,7 +132,7 @@ a <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><s </p> </div> <hr> -<div class="refsect2" title="enum NMSettingConnectionError"> +<div class="refsect2"> <a name="NMSettingConnectionError"></a><h3>enum NMSettingConnectionError</h3> <pre class="programlisting">typedef enum { @@ -145,14 +170,14 @@ Describes errors that may result from operations involving a <td><p><a name="NM-SETTING-CONNECTION-ERROR-TYPE-SETTING-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND</code></span></p></td> <td>the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object referenced by the setting name contained in the - <a class="link" href="NMSettingConnection.html#NMSettingConnection--type" title='The "type" property'><span class="type">"type"</span></a> property was not present in the <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> + <a class="link" href="NMSettingConnection.html#NMSettingConnection--type" title='The "type" property'><span class="type">"type"</span></a> property was not present in the <span class="type">NMConnection</span> </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="NM_TYPE_SETTING_CONNECTION_ERROR"> +<div class="refsect2"> <a name="NM-TYPE-SETTING-CONNECTION-ERROR:CAPS"></a><h3>NM_TYPE_SETTING_CONNECTION_ERROR</h3> <pre class="programlisting">#define NM_TYPE_SETTING_CONNECTION_ERROR (nm_setting_connection_error_get_type ()) </pre> @@ -160,7 +185,7 @@ Describes errors that may result from operations involving a </p> </div> <hr> -<div class="refsect2" title="NM_SETTING_CONNECTION_ERROR"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-ERROR:CAPS"></a><h3>NM_SETTING_CONNECTION_ERROR</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark () </pre> @@ -168,7 +193,7 @@ Describes errors that may result from operations involving a </p> </div> <hr> -<div class="refsect2" title="nm_setting_connection_error_quark ()"> +<div class="refsect2"> <a name="nm-setting-connection-error-quark"></a><h3>nm_setting_connection_error_quark ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_setting_connection_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> @@ -178,13 +203,12 @@ Registers an error quark for <a class="link" href="NMSettingConnection.html" tit <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the error quark used for <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> errors. -</td> +<td>the error quark used for <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> errors.</td> </tr></tbody> </table></div> </div> <hr> -<div class="refsect2" title="NM_SETTING_CONNECTION_ID"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-ID:CAPS"></a><h3>NM_SETTING_CONNECTION_ID</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_ID "id" </pre> @@ -192,7 +216,7 @@ Registers an error quark for <a class="link" href="NMSettingConnection.html" tit </p> </div> <hr> -<div class="refsect2" title="NM_SETTING_CONNECTION_UUID"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-UUID:CAPS"></a><h3>NM_SETTING_CONNECTION_UUID</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_UUID "uuid" </pre> @@ -200,7 +224,7 @@ Registers an error quark for <a class="link" href="NMSettingConnection.html" tit </p> </div> <hr> -<div class="refsect2" title="NM_SETTING_CONNECTION_TYPE"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-TYPE:CAPS"></a><h3>NM_SETTING_CONNECTION_TYPE</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_TYPE "type" </pre> @@ -208,7 +232,7 @@ Registers an error quark for <a class="link" href="NMSettingConnection.html" tit </p> </div> <hr> -<div class="refsect2" title="NM_SETTING_CONNECTION_AUTOCONNECT"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-AUTOCONNECT:CAPS"></a><h3>NM_SETTING_CONNECTION_AUTOCONNECT</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect" </pre> @@ -216,7 +240,7 @@ Registers an error quark for <a class="link" href="NMSettingConnection.html" tit </p> </div> <hr> -<div class="refsect2" title="NM_SETTING_CONNECTION_TIMESTAMP"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-TIMESTAMP:CAPS"></a><h3>NM_SETTING_CONNECTION_TIMESTAMP</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_TIMESTAMP "timestamp" </pre> @@ -224,7 +248,7 @@ Registers an error quark for <a class="link" href="NMSettingConnection.html" tit </p> </div> <hr> -<div class="refsect2" title="NM_SETTING_CONNECTION_READ_ONLY"> +<div class="refsect2"> <a name="NM-SETTING-CONNECTION-READ-ONLY:CAPS"></a><h3>NM_SETTING_CONNECTION_READ_ONLY</h3> <pre class="programlisting">#define NM_SETTING_CONNECTION_READ_ONLY "read-only" </pre> @@ -232,7 +256,15 @@ Registers an error quark for <a class="link" href="NMSettingConnection.html" tit </p> </div> <hr> -<div class="refsect2" title="NMSettingConnection"> +<div class="refsect2"> +<a name="NM-SETTING-CONNECTION-PERMISSIONS:CAPS"></a><h3>NM_SETTING_CONNECTION_PERMISSIONS</h3> +<pre class="programlisting">#define NM_SETTING_CONNECTION_PERMISSIONS "permissions" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> <a name="NMSettingConnection-struct"></a><h3>NMSettingConnection</h3> <pre class="programlisting">typedef struct _NMSettingConnection NMSettingConnection;</pre> <p> @@ -241,7 +273,7 @@ It should only be accessed through the functions described below. </p> </div> <hr> -<div class="refsect2" title="NMSettingConnectionClass"> +<div class="refsect2"> <a name="NMSettingConnectionClass"></a><h3>NMSettingConnectionClass</h3> <pre class="programlisting">typedef struct { NMSettingClass parent; @@ -257,22 +289,14 @@ It should only be accessed through the functions described below. </p> </div> <hr> -<div class="refsect2" title="nm_setting_connection_get_type ()"> +<div class="refsect2"> <a name="nm-setting-connection-get-type"></a><h3>nm_setting_connection_get_type ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> nm_setting_connection_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> </p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -</td> -</tr></tbody> -</table></div> </div> <hr> -<div class="refsect2" title="nm_setting_connection_new ()"> +<div class="refsect2"> <a name="nm-setting-connection-new"></a><h3>nm_setting_connection_new ()</h3> <pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_connection_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> @@ -282,13 +306,12 @@ Creates a new <a class="link" href="NMSettingConnection.html" title="NMSettingCo <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the new empty <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> object -</td> +<td>the new empty <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> object</td> </tr></tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_setting_connection_get_id ()"> +<div class="refsect2"> <a name="nm-setting-connection-get-id"></a><h3>nm_setting_connection_get_id ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_connection_get_id (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>);</pre> <p> @@ -304,14 +327,13 @@ Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection-- </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the connection ID -</td> +<td>the connection ID</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_setting_connection_get_uuid ()"> +<div class="refsect2"> <a name="nm-setting-connection-get-uuid"></a><h3>nm_setting_connection_get_uuid ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_connection_get_uuid (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>);</pre> <p> @@ -327,14 +349,13 @@ Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection-- </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the connection UUID -</td> +<td>the connection UUID</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_setting_connection_get_connection_type ()"> +<div class="refsect2"> <a name="nm-setting-connection-get-connection-type"></a><h3>nm_setting_connection_get_connection_type ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_connection_get_connection_type (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>);</pre> @@ -351,14 +372,13 @@ Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection-- </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the connection type -</td> +<td>the connection type</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_setting_connection_get_autoconnect ()"> +<div class="refsect2"> <a name="nm-setting-connection-get-autoconnect"></a><h3>nm_setting_connection_get_autoconnect ()</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_connection_get_autoconnect (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>);</pre> @@ -375,14 +395,13 @@ Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection-- </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the connection's autoconnect behavior -</td> +<td>the connection's autoconnect behavior</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_setting_connection_get_timestamp ()"> +<div class="refsect2"> <a name="nm-setting-connection-get-timestamp"></a><h3>nm_setting_connection_get_timestamp ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> nm_setting_connection_get_timestamp (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>);</pre> <p> @@ -398,14 +417,13 @@ Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection-- </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> the connection's timestamp -</td> +<td>the connection's timestamp</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="nm_setting_connection_get_read_only ()"> +<div class="refsect2"> <a name="nm-setting-connection-get-read-only"></a><h3>nm_setting_connection_get_read_only ()</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_connection_get_read_only (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>);</pre> <p> @@ -421,16 +439,184 @@ Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection-- </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection is read-only, <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> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection is read-only, <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"> +<a name="nm-setting-connection-get-num-permissions"></a><h3>nm_setting_connection_get_num_permissions ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_connection_get_num_permissions + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>);</pre> +<p> +Returns the number of entires in the <a class="link" href="NMSettingConnection.html#NMSettingConnection--permissions" title='The "permissions" property'><span class="type">"permissions"</span></a> +property of this setting. +</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="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> </td> </tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of permissions entires</td> +</tr> </tbody> </table></div> </div> +<hr> +<div class="refsect2"> +<a name="nm-setting-connection-get-permission"></a><h3>nm_setting_connection_get_permission ()</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_connection_get_permission + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> **out_ptype</code></em>, + <em class="parameter"><code>const <span class="type">char</span> **out_pitem</code></em>, + <em class="parameter"><code>const <span class="type">char</span> **out_detail</code></em>);</pre> +<p> +Retrieve one of the entries of the <a class="link" href="NMSettingConnection.html#NMSettingConnection--permissions" title='The "permissions" property'><span class="type">"permissions"</span></a> property +of this setting. +</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="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>idx</code></em> :</span></p></td> +<td>the zero-based index of the permissions entry</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>out_ptype</code></em> :</span></p></td> +<td>on return, the permission type (at this time, always "user")</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>out_pitem</code></em> :</span></p></td> +<td>on return, the permission item (formatted accoring to <em class="parameter"><code>ptype</code></em>, see +<a class="link" href="NMSettingConnection.html#NMSettingConnection--permissions" title='The "permissions" property'><span class="type">"permissions"</span></a> for more detail</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>out_detail</code></em> :</span></p></td> +<td>on return, the permission detail (at this time, always NULL)</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 a permission was returned, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>idx</code></em> was invalid</td> +</tr> +</tbody> +</table></div> </div> -<div class="refsect1" title="Property Details"> +<hr> +<div class="refsect2"> +<a name="nm-setting-connection-permissions-user-allowed"></a><h3>nm_setting_connection_permissions_user_allowed ()</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_connection_permissions_user_allowed + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *uname</code></em>);</pre> +<p> +Checks whether the given username is allowed to view/access this connection. +</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="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>uname</code></em> :</span></p></td> +<td>the user name to check permissions for</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 requested user is allowed to view this connection, +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the given user is not allowed to view this connection</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-connection-add-permission"></a><h3>nm_setting_connection_add_permission ()</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_connection_add_permission + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *ptype</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *pitem</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *detail</code></em>);</pre> +<p> +Adds a permission to the connection's permission list. At this time, only +the "user" permission type is supported, and <em class="parameter"><code>pitem</code></em> must be a username. See +<a class="link" href="NMSettingConnection.html#NMSettingConnection--permissions" title='The "permissions" property'><span class="type">"permissions"</span></a>: for more details. +</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="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ptype</code></em> :</span></p></td> +<td>the permission type; at this time only "user" is supported</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>pitem</code></em> :</span></p></td> +<td>the permission item formatted as required for <em class="parameter"><code>ptype</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>detail</code></em> :</span></p></td> +<td>unused at this time; must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the permission was unique and was successfully added to the +list, FALSE if <em class="parameter"><code>ptype</code></em> or <em class="parameter"><code>pitem</code></em> was invalid or it the permission was already +present in the list</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-connection-remove-permission"></a><h3>nm_setting_connection_remove_permission ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> nm_setting_connection_remove_permission + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>);</pre> +<p> +Removes the permission at index <em class="parameter"><code>idx</code></em> from the connection. +</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="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>idx</code></em> :</span></p></td> +<td>the zero-based index of the permission to remove</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> <a name="NMSettingConnection.property-details"></a><h2>Property Details</h2> -<div class="refsect2" title='The "autoconnect" property'> +<div class="refsect2"> <a name="NMSettingConnection--autoconnect"></a><h3>The <code class="literal">"autoconnect"</code> property</h3> <pre class="programlisting"> "autoconnect" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> <p> @@ -442,7 +628,7 @@ intervention to activate the connection. Defaults to <a href="http://library.gn <p>Default value: TRUE</p> </div> <hr> -<div class="refsect2" title='The "id" property'> +<div class="refsect2"> <a name="NMSettingConnection--id"></a><h3>The <code class="literal">"id"</code> property</h3> <pre class="programlisting"> "id" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p> @@ -452,7 +638,29 @@ A human readable unique idenfier for the connection, like "Work WiFi" or <p>Default value: NULL</p> </div> <hr> -<div class="refsect2" title='The "read-only" property'> +<div class="refsect2"> +<a name="NMSettingConnection--permissions"></a><h3>The <code class="literal">"permissions"</code> property</h3> +<pre class="programlisting"> "permissions" <span class="type">GSList_gchararray_</span>* : Read / Write</pre> +<p> +An array of strings defining what access a given user has to this +connection. If this is NULL or empty, all users are allowed to access +this connection. Otherwise a user is allowed to access this connection +if and only if they are in this list. Each entry is of the form +"[type]:[id]:[reserved]", for example: +</p> +<p> + user:dcbw:blah +</p> +<p> +At this time only the 'user' [type] is allowed. Any other values are +ignored and reserved for future use. [id] is the username that this +permission refers to, which may not contain the ':' character. Any +[reserved] information present must be ignored and is reserved for +future use. All of [type], [id], and [reserved] must be valid UTF-8. +</p> +</div> +<hr> +<div class="refsect2"> <a name="NMSettingConnection--read-only"></a><h3>The <code class="literal">"read-only"</code> property</h3> <pre class="programlisting"> "read-only" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> <p> @@ -463,7 +671,7 @@ if the connection is read-only and cannot be modified. <p>Default value: FALSE</p> </div> <hr> -<div class="refsect2" title='The "timestamp" property'> +<div class="refsect2"> <a name="NMSettingConnection--timestamp"></a><h3>The <code class="literal">"timestamp"</code> property</h3> <pre class="programlisting"> "timestamp" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read / Write / Construct</pre> <p> @@ -473,7 +681,7 @@ _successfully_ fully activated. <p>Default value: 0</p> </div> <hr> -<div class="refsect2" title='The "type" property'> +<div class="refsect2"> <a name="NMSettingConnection--type"></a><h3>The <code class="literal">"type"</code> property</h3> <pre class="programlisting"> "type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p> @@ -485,7 +693,7 @@ type's parameters. For example, for WiFi devices, the name of the <p>Default value: NULL</p> </div> <hr> -<div class="refsect2" title='The "uuid" property'> +<div class="refsect2"> <a name="NMSettingConnection--uuid"></a><h3>The <code class="literal">"uuid"</code> property</h3> <pre class="programlisting"> "uuid" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p> @@ -509,6 +717,6 @@ be generated by <a class="link" href="libnm-util-nm-utils.html#nm-utils-uuid-gen </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.15</div> + Generated by GTK-Doc V1.17</div> </body> </html> \ No newline at end of file |