diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingConnection.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingConnection.html | 514 |
1 files changed, 514 insertions, 0 deletions
diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html new file mode 100644 index 00000000..8fa7c953 --- /dev/null +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -0,0 +1,514 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingConnection</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="NMSetting.html" title="NMSetting"> +<link rel="next" href="NMSettingWired.html" title="NMSettingWired"> +<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="NMSetting.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="NMSettingWired.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingConnection.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingConnection.description" class="shortcut">Description</a> + | + <a href="#NMSettingConnection.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingConnection.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry" title="NMSettingConnection"> +<a name="NMSettingConnection"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingConnection.top_of_page"></a>NMSettingConnection</span></h2> +<p>NMSettingConnection — Describes general connection properties</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="NMSettingConnection.synopsis"></a><h2>Synopsis</h2> +<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>; +#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="/usr/share/gtk-doc/html/glib/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>); +#define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-ID:CAPS" title="NM_SETTING_CONNECTION_ID">NM_SETTING_CONNECTION_ID</a> +#define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-UUID:CAPS" title="NM_SETTING_CONNECTION_UUID">NM_SETTING_CONNECTION_UUID</a> +#define <a class="link" href="NMSettingConnection.html#NM-SETTING-CONNECTION-TYPE:CAPS" title="NM_SETTING_CONNECTION_TYPE">NM_SETTING_CONNECTION_TYPE</a> +#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> + <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="/usr/share/gtk-doc/html/gobject/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>); +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingConnection.html#nm-setting-connection-new" title="nm_setting_connection_new ()">nm_setting_connection_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-id" title="nm_setting_connection_get_id ()">nm_setting_connection_get_id</a> (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-uuid" title="nm_setting_connection_get_uuid ()">nm_setting_connection_get_uuid</a> (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingConnection.html#nm-setting-connection-get-connection-type" title="nm_setting_connection_get_connection_type ()">nm_setting_connection_get_connection_type</a> + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</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="NMSettingConnection.html#nm-setting-connection-get-autoconnect" title="nm_setting_connection_get_autoconnect ()">nm_setting_connection_get_autoconnect</a> + (<em class="parameter"><code><a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> *setting</code></em>); +<a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="NMSettingConnection.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> + +----<a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> + +----NMSettingConnection +</pre> +</div> +<div class="refsect1" title="Properties"> +<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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="NMSettingConnection.html#NMSettingConnection--read-only" title='The "read-only" property'>read-only</a>" <a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/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="/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="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 +a <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> setting. +</p> +</div> +<div class="refsect1" title="Details"> +<a name="NMSettingConnection.details"></a><h2>Details</h2> +<div class="refsect2" title="NM_SETTING_CONNECTION_SETTING_NAME"> +<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> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="enum NMSettingConnectionError"> +<a name="NMSettingConnectionError"></a><h3>enum NMSettingConnectionError</h3> +<pre class="programlisting">typedef enum +{ + NM_SETTING_CONNECTION_ERROR_UNKNOWN = 0, + NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY, + NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY, + NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND +} NMSettingConnectionError; +</pre> +<p> +Describes errors that may result from operations involving a +<a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="NM-SETTING-CONNECTION-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CONNECTION_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-CONNECTION-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY</code></span></p></td> +<td>the property's value is + invalid +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-CONNECTION-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY</code></span></p></td> +<td>a required property is not + present +</td> +</tr> +<tr> +<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> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="NM_TYPE_SETTING_CONNECTION_ERROR"> +<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> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_CONNECTION_ERROR"> +<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> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="nm_setting_connection_error_quark ()"> +<a name="nm-setting-connection-error-quark"></a><h3>nm_setting_connection_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_connection_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> if necessary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the error quark used for <a class="link" href="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"> +<a name="NM-SETTING-CONNECTION-ID:CAPS"></a><h3>NM_SETTING_CONNECTION_ID</h3> +<pre class="programlisting">#define NM_SETTING_CONNECTION_ID "id" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_CONNECTION_UUID"> +<a name="NM-SETTING-CONNECTION-UUID:CAPS"></a><h3>NM_SETTING_CONNECTION_UUID</h3> +<pre class="programlisting">#define NM_SETTING_CONNECTION_UUID "uuid" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_CONNECTION_TYPE"> +<a name="NM-SETTING-CONNECTION-TYPE:CAPS"></a><h3>NM_SETTING_CONNECTION_TYPE</h3> +<pre class="programlisting">#define NM_SETTING_CONNECTION_TYPE "type" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_CONNECTION_AUTOCONNECT"> +<a name="NM-SETTING-CONNECTION-AUTOCONNECT:CAPS"></a><h3>NM_SETTING_CONNECTION_AUTOCONNECT</h3> +<pre class="programlisting">#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_CONNECTION_TIMESTAMP"> +<a name="NM-SETTING-CONNECTION-TIMESTAMP:CAPS"></a><h3>NM_SETTING_CONNECTION_TIMESTAMP</h3> +<pre class="programlisting">#define NM_SETTING_CONNECTION_TIMESTAMP "timestamp" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_CONNECTION_READ_ONLY"> +<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> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NMSettingConnection"> +<a name="NMSettingConnection-struct"></a><h3>NMSettingConnection</h3> +<pre class="programlisting">typedef struct _NMSettingConnection NMSettingConnection;</pre> +<p> +The NMSettingConnection struct contains only private data. +It should only be accessed through the functions described below. +</p> +</div> +<hr> +<div class="refsect2" title="NMSettingConnectionClass"> +<a name="NMSettingConnectionClass"></a><h3>NMSettingConnectionClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingConnectionClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="nm_setting_connection_get_type ()"> +<a name="nm-setting-connection-get-type"></a><h3>nm_setting_connection_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_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 ()"> +<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> +Creates a new <a class="link" href="NMSettingConnection.html" title="NMSettingConnection"><span class="type">NMSettingConnection</span></a> object with default values. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the new empty <a class="link" href="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 ()"> +<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> +Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection--id" title='The "id" property'><span class="type">"id"</span></a> property of 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the connection ID +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_connection_get_uuid ()"> +<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> +Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection--uuid" title='The "uuid" property'><span class="type">"uuid"</span></a> property of 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the connection UUID +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_connection_get_connection_type ()"> +<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> +<p> +Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection--type" title='The "type" property'><span class="type">"type"</span></a> property of 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the connection type +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_connection_get_autoconnect ()"> +<a name="nm-setting-connection-get-autoconnect"></a><h3>nm_setting_connection_get_autoconnect ()</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_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> +<p> +Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection--autoconnect" title='The "autoconnect" property'><span class="type">"autoconnect"</span></a> property of 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the connection's autoconnect behavior +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_connection_get_timestamp ()"> +<a name="nm-setting-connection-get-timestamp"></a><h3>nm_setting_connection_get_timestamp ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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> +Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection--timestamp" title='The "timestamp" property'><span class="type">"timestamp"</span></a> property of 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the connection's timestamp +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_setting_connection_get_read_only ()"> +<a name="nm-setting-connection-get-read-only"></a><h3>nm_setting_connection_get_read_only ()</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_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> +Returns the <a class="link" href="NMSettingConnection.html#NMSettingConnection--read-only" title='The "read-only" property'><span class="type">"read-only"</span></a> property of 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"><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 connection is read-only, <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> +</div> +<div class="refsect1" title="Property Details"> +<a name="NMSettingConnection.property-details"></a><h2>Property Details</h2> +<div class="refsect2" title='The "autoconnect" property'> +<a name="NMSettingConnection--autoconnect"></a><h3>The <code class="literal">"autoconnect"</code> property</h3> +<pre class="programlisting"> "autoconnect" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> +<p> +Whether or not the connection should be automatically connected by +NetworkManager when the resources for the connection are available. +<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to automatically activate the connection, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to require manual +intervention to activate the connection. Defaults to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. +</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2" title='The "id" property'> +<a name="NMSettingConnection--id"></a><h3>The <code class="literal">"id"</code> property</h3> +<pre class="programlisting"> "id" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +A human readable unique idenfier for the connection, like "Work WiFi" or +"T-Mobile 3G". +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "read-only" property'> +<a name="NMSettingConnection--read-only"></a><h3>The <code class="literal">"read-only"</code> property</h3> +<pre class="programlisting"> "read-only" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> +<p> +<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection can be modified using the providing settings +service's D-Bus interface with the right privileges, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> +if the connection is read-only and cannot be modified. +</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2" title='The "timestamp" property'> +<a name="NMSettingConnection--timestamp"></a><h3>The <code class="literal">"timestamp"</code> property</h3> +<pre class="programlisting"> "timestamp" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read / Write / Construct</pre> +<p> +The time, in seconds since the Unix Epoch, that the connection was last +_successfully_ fully activated. +</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2" title='The "type" property'> +<a name="NMSettingConnection--type"></a><h3>The <code class="literal">"type"</code> property</h3> +<pre class="programlisting"> "type" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +The general hardware type of the device used for the network connection, +contains the name of the <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> object that describes that hardware +type's parameters. For example, for WiFi devices, the name of the +<a class="link" href="NMSettingWireless.html" title="NMSettingWireless"><span class="type">NMSettingWireless</span></a> setting. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "uuid" property'> +<a name="NMSettingConnection--uuid"></a><h3>The <code class="literal">"uuid"</code> property</h3> +<pre class="programlisting"> "uuid" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +A universally unique idenfier for the connection, for example generated +with libuuid. Should be assigned when the connection is created, and +never changed as long as the connection still applies to the same +network. For example, should not be changed when the +<a class="link" href="NMSettingConnection.html#NMSettingConnection--id" title='The "id" property'><span class="type">"id"</span></a> or <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> changes, but might need +to be re-created when the WiFi SSID, mobile broadband network provider, +or <a class="link" href="NMSettingConnection.html#NMSettingConnection--type" title='The "type" property'><span class="type">"type"</span></a> changes. +</p> +<p> +The UUID must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' +(ie, contains only hexadecimal characters and '-'). A suitable UUID may +be generated by <a class="link" href="libnm-util-nm-utils.html#nm-utils-uuid-generate" title="nm_utils_uuid_generate ()"><code class="function">nm_utils_uuid_generate()</code></a> or +<a class="link" href="libnm-util-nm-utils.html#nm-utils-uuid-generate-from-string" title="nm_utils_uuid_generate_from_string ()"><code class="function">nm_utils_uuid_generate_from_string()</code></a>. +</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 |