diff options
Diffstat (limited to 'docs/libnm-glib/html/NMDeviceVlan.html')
| -rw-r--r-- | docs/libnm-glib/html/NMDeviceVlan.html | 530 |
1 files changed, 241 insertions, 289 deletions
diff --git a/docs/libnm-glib/html/NMDeviceVlan.html b/docs/libnm-glib/html/NMDeviceVlan.html index b7952355..89e4a9ce 100644 --- a/docs/libnm-glib/html/NMDeviceVlan.html +++ b/docs/libnm-glib/html/NMDeviceVlan.html @@ -2,28 +2,36 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-glib Reference Manual: NMDeviceVlan</title> +<title>NMDeviceVlan</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-glib Reference Manual"> <link rel="up" href="ch02.html" title="libnm-glib API Reference"> <link rel="prev" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"> <link rel="next" href="NMDeviceOlpcMesh.html" title="NMDeviceOlpcMesh"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.19 (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="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"> -<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#NMDeviceVlan.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMDeviceVlan.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#NMDeviceVlan.properties" class="shortcut">Properties</a></span> -</td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="NMDeviceInfiniband.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="NMDeviceOlpcMesh.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="NMDeviceInfiniband.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch02.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-glib Reference Manual</th> +<td><a accesskey="n" href="NMDeviceOlpcMesh.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMDeviceVlan.synopsis" class="shortcut">Top</a> + | + <a href="#NMDeviceVlan.description" class="shortcut">Description</a> + | + <a href="#NMDeviceVlan.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMDeviceVlan.implemented-interfaces" class="shortcut">Implemented Interfaces</a> + | + <a href="#NMDeviceVlan.properties" class="shortcut">Properties</a> +</td></tr> +</table> <div class="refentry"> <a name="NMDeviceVlan"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -31,368 +39,312 @@ <h2><span class="refentrytitle"><a name="NMDeviceVlan.top_of_page"></a>NMDeviceVlan</span></h2> <p>NMDeviceVlan</p> </td> -<td class="gallery_image" valign="top" align="right"></td> +<td valign="top" align="right"></td> </tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMDeviceVlan.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">enum <a class="link" href="NMDeviceVlan.html#NMDeviceVlanError" title="enum NMDeviceVlanError">NMDeviceVlanError</a>; +#define <a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-ERROR:CAPS" title="NM_DEVICE_VLAN_ERROR">NM_DEVICE_VLAN_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="NMDeviceVlan.html#nm-device-vlan-error-quark" title="nm_device_vlan_error_quark ()">nm_device_vlan_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +#define <a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-HW-ADDRESS:CAPS" title="NM_DEVICE_VLAN_HW_ADDRESS">NM_DEVICE_VLAN_HW_ADDRESS</a> +#define <a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-CARRIER:CAPS" title="NM_DEVICE_VLAN_CARRIER">NM_DEVICE_VLAN_CARRIER</a> +#define <a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-VLAN-ID:CAPS" title="NM_DEVICE_VLAN_VLAN_ID">NM_DEVICE_VLAN_VLAN_ID</a> + <a class="link" href="NMDeviceVlan.html#NMDeviceVlan-struct" title="NMDeviceVlan">NMDeviceVlan</a>; + <a class="link" href="NMDeviceVlan.html#NMDeviceVlanClass" title="NMDeviceVlanClass">NMDeviceVlanClass</a>; +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="NMDeviceVlan.html#nm-device-vlan-new" title="nm_device_vlan_new ()">nm_device_vlan_new</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMDeviceVlan.html#nm-device-vlan-get-hw-address" title="nm_device_vlan_get_hw_address ()">nm_device_vlan_get_hw_address</a> (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</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="NMDeviceVlan.html#nm-device-vlan-get-carrier" title="nm_device_vlan_get_carrier ()">nm_device_vlan_get_carrier</a> (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="NMDeviceVlan.html#nm-device-vlan-get-vlan-id" title="nm_device_vlan_get_vlan_id ()">nm_device_vlan_get_vlan_id</a> (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMDeviceVlan.object-hierarchy"></a><h2>Object Hierarchy</h2> +<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="NMObject.html" title="NMObject">NMObject</a> + +----<a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> + +----NMDeviceVlan +</pre> +</div> +<div class="refsect1"> +<a name="NMDeviceVlan.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +NMDeviceVlan implements + <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> +</div> +<div class="refsect1"> +<a name="NMDeviceVlan.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMDeviceVlan.html#NMDeviceVlan--carrier" title='The "carrier" property'>carrier</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read + "<a class="link" href="NMDeviceVlan.html#NMDeviceVlan--hw-address" title='The "hw-address" property'>hw-address</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read + "<a class="link" href="NMDeviceVlan.html#NMDeviceVlan--vlan-id" title='The "vlan-id" property'>vlan-id</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read +</pre> +</div> +<div class="refsect1"> +<a name="NMDeviceVlan.description"></a><h2>Description</h2> +<p> +</p> +</div> <div class="refsect1"> -<a name="NMDeviceVlan.functions"></a><h2>Functions</h2> -<div class="informaltable"><table width="100%" border="0"> +<a name="NMDeviceVlan.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NMDeviceVlanError"></a><h3>enum NMDeviceVlanError</h3> +<pre class="programlisting">typedef enum { + NM_DEVICE_VLAN_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ + NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION, /*< nick=NotVlanConnection >*/ + NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION, /*< nick=InvalidVlanConnection >*/ + NM_DEVICE_VLAN_ERROR_ID_MISMATCH, /*< nick=IdMismatch >*/ + NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH, /*< nick=InterfaceMismatch >*/ + NM_DEVICE_VLAN_ERROR_MAC_MISMATCH, /*< nick=MacMismatch >*/ +} NMDeviceVlanError; +</pre> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="150px" class="functions_return"> -<col class="functions_name"> +<col align="left" valign="top"> +<col> </colgroup> <tbody> <tr> -<td class="function_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> -</td> -<td class="function_name"> -<a class="link" href="NMDeviceVlan.html#nm-device-vlan-error-quark" title="nm_device_vlan_error_quark ()">nm_device_vlan_error_quark</a> <span class="c_punctuation">()</span> +<td><p><a name="NM-DEVICE-VLAN-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_VLAN_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error </td> </tr> <tr> -<td class="function_type"> -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * -</td> -<td class="function_name"> -<a class="link" href="NMDeviceVlan.html#nm-device-vlan-new" title="nm_device_vlan_new ()">nm_device_vlan_new</a> <span class="c_punctuation">()</span> +<td><p><a name="NM-DEVICE-VLAN-ERROR-NOT-VLAN-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION</code></span></p></td> +<td>the connection was not of VLAN type </td> </tr> <tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="NMDeviceVlan.html#nm-device-vlan-get-hw-address" title="nm_device_vlan_get_hw_address ()">nm_device_vlan_get_hw_address</a> <span class="c_punctuation">()</span> +<td><p><a name="NM-DEVICE-VLAN-ERROR-INVALID-VLAN-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION</code></span></p></td> +<td>the VLAN connection was invalid </td> </tr> <tr> -<td class="function_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> -</td> -<td class="function_name"> -<a class="link" href="NMDeviceVlan.html#nm-device-vlan-get-carrier" title="nm_device_vlan_get_carrier ()">nm_device_vlan_get_carrier</a> <span class="c_punctuation">()</span> +<td><p><a name="NM-DEVICE-VLAN-ERROR-ID-MISMATCH:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_VLAN_ERROR_ID_MISMATCH</code></span></p></td> +<td>the VLAN identifiers of the connection and the device mismatched </td> </tr> <tr> -<td class="function_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +<td><p><a name="NM-DEVICE-VLAN-ERROR-INTERFACE-MISMATCH:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH</code></span></p></td> +<td>the interfaces of the connection and the device mismatched </td> -<td class="function_name"> -<a class="link" href="NMDeviceVlan.html#nm-device-vlan-get-vlan-id" title="nm_device_vlan_get_vlan_id ()">nm_device_vlan_get_vlan_id</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="NMDeviceVlan.properties"></a><h2>Properties</h2> -<div class="informaltable"><table border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> -<td class="property_name"><a class="link" href="NMDeviceVlan.html#NMDeviceVlan--carrier" title="The “carrier” property">carrier</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> -<td class="property_name"><a class="link" href="NMDeviceVlan.html#NMDeviceVlan--hw-address" title="The “hw-address” property">hw-address</a></td> -<td class="property_flags">Read</td> </tr> <tr> -<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMDeviceVlan.html#NMDeviceVlan--vlan-id" title="The “vlan-id” property">vlan-id</a></td> -<td class="property_flags">Read</td> +<td><p><a name="NM-DEVICE-VLAN-ERROR-MAC-MISMATCH:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_VLAN_ERROR_MAC_MISMATCH</code></span></p></td> +<td>the MACs of the connection and the device mismatched +</td> </tr> </tbody> </table></div> </div> -<div class="refsect1"> -<a name="NMDeviceVlan.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table width="100%" border="0"> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-VLAN-ERROR:CAPS"></a><h3>NM_DEVICE_VLAN_ERROR</h3> +<pre class="programlisting">#define NM_DEVICE_VLAN_ERROR nm_device_vlan_error_quark () +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-vlan-error-quark"></a><h3>nm_device_vlan_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_device_vlan_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> if necessary. +</p> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="150px" class="name"> -<col class="description"> +<col align="left" valign="top"> +<col> </colgroup> -<tbody> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="NMDeviceVlan.html#NMDeviceVlanError" title="enum NMDeviceVlanError">NMDeviceVlanError</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-ERROR:CAPS" title="NM_DEVICE_VLAN_ERROR">NM_DEVICE_VLAN_ERROR</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-HW-ADDRESS:CAPS" title="NM_DEVICE_VLAN_HW_ADDRESS">NM_DEVICE_VLAN_HW_ADDRESS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-CARRIER:CAPS" title="NM_DEVICE_VLAN_CARRIER">NM_DEVICE_VLAN_CARRIER</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="NMDeviceVlan.html#NM-DEVICE-VLAN-VLAN-ID:CAPS" title="NM_DEVICE_VLAN_VLAN_ID">NM_DEVICE_VLAN_VLAN_ID</a></td> -</tr> -</tbody> +<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="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> errors.</td> +</tr></tbody> </table></div> </div> -<div class="refsect1"> -<a name="NMDeviceVlan.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> - <span class="lineart">╰──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> - <span class="lineart">╰──</span> NMDeviceVlan +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-VLAN-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_VLAN_HW_ADDRESS</h3> +<pre class="programlisting">#define NM_DEVICE_VLAN_HW_ADDRESS "hw-address" </pre> +<p> +</p> </div> -<div class="refsect1"> -<a name="NMDeviceVlan.description"></a><h2>Description</h2> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-VLAN-CARRIER:CAPS"></a><h3>NM_DEVICE_VLAN_CARRIER</h3> +<pre class="programlisting">#define NM_DEVICE_VLAN_CARRIER "carrier" +</pre> <p> </p> </div> -<div class="refsect1"> -<a name="NMDeviceVlan.functions_details"></a><h2>Functions</h2> +<hr> <div class="refsect2"> -<a name="nm-device-vlan-error-quark"></a><h3>nm_device_vlan_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_device_vlan_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Registers an error quark for <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> if necessary.</p> -<div class="refsect3"> -<a name="id-1.3.14.8.2.5"></a><h4>Returns</h4> -<p> the error quark used for <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> errors.</p> -<p></p> +<a name="NM-DEVICE-VLAN-VLAN-ID:CAPS"></a><h3>NM_DEVICE_VLAN_VLAN_ID</h3> +<pre class="programlisting">#define NM_DEVICE_VLAN_VLAN_ID "vlan-id" +</pre> +<p> +</p> </div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVlan-struct"></a><h3>NMDeviceVlan</h3> +<pre class="programlisting">typedef struct _NMDeviceVlan NMDeviceVlan;</pre> +<p> +</p> </div> <hr> <div class="refsect2"> -<a name="nm-device-vlan-new"></a><h3>nm_device_vlan_new ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * -nm_device_vlan_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> -<p>Creates a new <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a>.</p> -<div class="refsect3"> -<a name="id-1.3.14.8.3.5"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="NMDeviceVlanClass"></a><h3>NMDeviceVlanClass</h3> +<pre class="programlisting">typedef struct { + NMDeviceClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); + void (*_reserved5) (void); + void (*_reserved6) (void); +} NMDeviceVlanClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-vlan-new"></a><h3>nm_device_vlan_new ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_device_vlan_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> +<p> +Creates a new <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a>. +</p> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> +<col align="left" valign="top"> +<col> </colgroup> <tbody> <tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a></p></td> -<td class="parameter_annotations"> </td> +<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> +<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>the DBus object path of the device</td> </tr> <tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the DBus object path of the device</p></td> -<td class="parameter_annotations"> </td> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new device. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> </tr> </tbody> </table></div> </div> -<div class="refsect3"> -<a name="id-1.3.14.8.3.6"></a><h4>Returns</h4> -<p> a new device. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> <hr> <div class="refsect2"> -<a name="nm-device-vlan-get-hw-address"></a><h3>nm_device_vlan_get_hw_address ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -nm_device_vlan_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>);</pre> -<p>Gets the hardware (MAC) address of the <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a></p> -<div class="refsect3"> -<a name="id-1.3.14.8.4.5"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="nm-device-vlan-get-hw-address"></a><h3>nm_device_vlan_get_hw_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_vlan_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>);</pre> +<p> +Gets the hardware (MAC) address of the <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> +</p> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> +<col align="left" valign="top"> +<col> </colgroup> -<tbody><tr> -<td class="parameter_name"><p>device</p></td> -<td class="parameter_description"><p>a <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the hardware address. This is the internal string used by the +device, and must not be modified.</td> +</tr> +</tbody> </table></div> </div> -<div class="refsect3"> -<a name="id-1.3.14.8.4.6"></a><h4>Returns</h4> -<p> the hardware address. This is the internal string used by the -device, and must not be modified.</p> -<p></p> -</div> -</div> <hr> <div class="refsect2"> -<a name="nm-device-vlan-get-carrier"></a><h3>nm_device_vlan_get_carrier ()</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_device_vlan_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>);</pre> -<p>Whether the device has carrier.</p> -<div class="refsect3"> -<a name="id-1.3.14.8.5.5"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="nm-device-vlan-get-carrier"></a><h3>nm_device_vlan_get_carrier ()</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_device_vlan_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>);</pre> +<p> +Whether the device has carrier. +</p> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> +<col align="left" valign="top"> +<col> </colgroup> -<tbody><tr> -<td class="parameter_name"><p>device</p></td> -<td class="parameter_description"><p>a <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the device has carrier</td> +</tr> +</tbody> </table></div> </div> -<div class="refsect3"> -<a name="id-1.3.14.8.5.6"></a><h4>Returns</h4> -<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the device has carrier</p> -<p></p> -</div> -</div> <hr> <div class="refsect2"> -<a name="nm-device-vlan-get-vlan-id"></a><h3>nm_device_vlan_get_vlan_id ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> -nm_device_vlan_get_vlan_id (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>);</pre> -<div class="refsect3"> -<a name="id-1.3.14.8.6.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="nm-device-vlan-get-vlan-id"></a><h3>nm_device_vlan_get_vlan_id ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> nm_device_vlan_get_vlan_id (<em class="parameter"><code><a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> *device</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> <colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>device</p></td> -<td class="parameter_description"><p>a <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.14.8.6.5"></a><h4>Returns</h4> -<p> the device's VLAN ID</p> -<p></p> -</div> -</div> -</div> -<div class="refsect1"> -<a name="NMDeviceVlan.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="NMDeviceVlanError"></a><h3>enum NMDeviceVlanError</h3> -<div class="refsect3"> -<a name="id-1.3.14.9.2.3"></a><h4>Members</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> +<col align="left" valign="top"> +<col> </colgroup> <tbody> <tr> -<td class="enum_member_name"><p><a name="NM-DEVICE-VLAN-ERROR-UNKNOWN:CAPS"></a>NM_DEVICE_VLAN_ERROR_UNKNOWN</p></td> -<td class="enum_member_description"> -<p>unknown or unclassified error</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="NM-DEVICE-VLAN-ERROR-NOT-VLAN-CONNECTION:CAPS"></a>NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION</p></td> -<td class="enum_member_description"> -<p>the connection was not of VLAN type</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="NM-DEVICE-VLAN-ERROR-INVALID-VLAN-CONNECTION:CAPS"></a>NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION</p></td> -<td class="enum_member_description"> -<p>the VLAN connection was invalid</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="NM-DEVICE-VLAN-ERROR-ID-MISMATCH:CAPS"></a>NM_DEVICE_VLAN_ERROR_ID_MISMATCH</p></td> -<td class="enum_member_description"> -<p>the VLAN identifiers of the connection and the device mismatched</p> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="NMDeviceVlan.html" title="NMDeviceVlan"><span class="type">NMDeviceVlan</span></a> </td> -<td class="enum_member_annotations"> </td> </tr> <tr> -<td class="enum_member_name"><p><a name="NM-DEVICE-VLAN-ERROR-INTERFACE-MISMATCH:CAPS"></a>NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH</p></td> -<td class="enum_member_description"> -<p>the interfaces of the connection and the device mismatched</p> -</td> -<td class="enum_member_annotations"> </td> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the device's VLAN ID</td> </tr> </tbody> </table></div> </div> </div> -<hr> +<div class="refsect1"> +<a name="NMDeviceVlan.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NM-DEVICE-VLAN-ERROR:CAPS"></a><h3>NM_DEVICE_VLAN_ERROR</h3> -<pre class="programlisting">#define NM_DEVICE_VLAN_ERROR nm_device_vlan_error_quark () -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-DEVICE-VLAN-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_VLAN_HW_ADDRESS</h3> -<pre class="programlisting">#define NM_DEVICE_VLAN_HW_ADDRESS "hw-address" -</pre> +<a name="NMDeviceVlan--carrier"></a><h3>The <code class="literal">"carrier"</code> property</h3> +<pre class="programlisting"> "carrier" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre> <p> +Whether the device has carrier. </p> +<p>Default value: FALSE</p> </div> <hr> <div class="refsect2"> -<a name="NM-DEVICE-VLAN-CARRIER:CAPS"></a><h3>NM_DEVICE_VLAN_CARRIER</h3> -<pre class="programlisting">#define NM_DEVICE_VLAN_CARRIER "carrier" -</pre> +<a name="NMDeviceVlan--hw-address"></a><h3>The <code class="literal">"hw-address"</code> property</h3> +<pre class="programlisting"> "hw-address" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> <p> +The hardware (MAC) address of the device. </p> +<p>Default value: NULL</p> </div> <hr> <div class="refsect2"> -<a name="NM-DEVICE-VLAN-VLAN-ID:CAPS"></a><h3>NM_DEVICE_VLAN_VLAN_ID</h3> -<pre class="programlisting">#define NM_DEVICE_VLAN_VLAN_ID "vlan-id" -</pre> +<a name="NMDeviceVlan--vlan-id"></a><h3>The <code class="literal">"vlan-id"</code> property</h3> +<pre class="programlisting"> "vlan-id" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> <p> +The device's VLAN ID. </p> -</div> -</div> -<div class="refsect1"> -<a name="NMDeviceVlan.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="NMDeviceVlan--carrier"></a><h3>The <code class="literal">“carrier”</code> property</h3> -<pre class="programlisting"> “carrier” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> -<p>Carrier.</p> -<p>Flags: Read</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMDeviceVlan--hw-address"></a><h3>The <code class="literal">“hw-address”</code> property</h3> -<pre class="programlisting"> “hw-address” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> -<p>Currently set hardware MAC address.</p> -<p>Flags: Read</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMDeviceVlan--vlan-id"></a><h3>The <code class="literal">“vlan-id”</code> property</h3> -<pre class="programlisting"> “vlan-id” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>VLAN ID.</p> -<p>Flags: Read</p> <p>Allowed values: <= 4095</p> <p>Default value: 0</p> </div> @@ -400,6 +352,6 @@ nm_device_vlan_get_vlan_id (<em class="parameter"><code><a class="link" href="NM </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.20</div> + Generated by GTK-Doc V1.19</div> </body> </html> \ No newline at end of file |