diff options
Diffstat (limited to 'docs/libnm/html/NMDeviceVlan.html')
| -rw-r--r-- | docs/libnm/html/NMDeviceVlan.html | 278 |
1 files changed, 278 insertions, 0 deletions
diff --git a/docs/libnm/html/NMDeviceVlan.html b/docs/libnm/html/NMDeviceVlan.html new file mode 100644 index 00000000..7351cc96 --- /dev/null +++ b/docs/libnm/html/NMDeviceVlan.html @@ -0,0 +1,278 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMDeviceVlan</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libnm Reference Manual"> +<link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> +<link rel="prev" href="NMDeviceTeam.html" title="NMDeviceTeam"> +<link rel="next" href="NMDeviceWifi.html" title="NMDeviceWifi"> +<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="2"> +<tr valign="middle"> +<td><a accesskey="p" href="NMDeviceTeam.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch04.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 Reference Manual</th> +<td><a accesskey="n" href="NMDeviceWifi.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> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMDeviceVlan.top_of_page"></a>NMDeviceVlan</span></h2> +<p>NMDeviceVlan</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMDeviceVlan.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#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-PARENT:CAPS" title="NM_DEVICE_VLAN_PARENT">NM_DEVICE_VLAN_PARENT</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> +struct <a class="link" href="NMDeviceVlan.html#NMDeviceVlan-struct" title="struct NMDeviceVlan">NMDeviceVlan</a>; + <a class="link" href="NMDeviceVlan.html#NMDeviceVlanClass" title="NMDeviceVlanClass">NMDeviceVlanClass</a>; +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 class="link" href="NMDevice.html" title="NMDevice"><span class="returnvalue">NMDevice</span></a> * <a class="link" href="NMDeviceVlan.html#nm-device-vlan-get-parent" title="nm_device_vlan_get_parent ()">nm_device_vlan_get_parent</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--parent" title='The "parent" property'>parent</a>" <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</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.details"></a><h2>Details</h2> +<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> +<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> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-VLAN-PARENT:CAPS"></a><h3>NM_DEVICE_VLAN_PARENT</h3> +<pre class="programlisting">#define NM_DEVICE_VLAN_PARENT "parent" +</pre> +<p> +</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> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVlan-struct"></a><h3>struct NMDeviceVlan</h3> +<pre class="programlisting">struct NMDeviceVlan;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVlanClass"></a><h3>NMDeviceVlanClass</h3> +<pre class="programlisting">typedef struct { + NMDeviceClass parent; +} NMDeviceVlanClass; +</pre> +<p> +</p> +</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="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<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> +<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="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<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> +<hr> +<div class="refsect2"> +<a name="nm-device-vlan-get-parent"></a><h3>nm_device_vlan_get_parent ()</h3> +<pre class="programlisting"><a class="link" href="NMDevice.html" title="NMDevice"><span class="returnvalue">NMDevice</span></a> * nm_device_vlan_get_parent (<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 align="left" valign="top"> +<col> +</colgroup> +<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 device's parent device. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></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="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<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 device's VLAN ID</td> +</tr> +</tbody> +</table></div> +</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> : Read</pre> +<p> +Whether the device has carrier. +</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>* : Read</pre> +<p> +The hardware (MAC) address of the device. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVlan--parent"></a><h3>The <code class="literal">"parent"</code> property</h3> +<pre class="programlisting"> "parent" <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a>* : Read</pre> +<p> +The devices's parent device. +</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> : Read</pre> +<p> +The device's VLAN ID. +</p> +<p>Allowed values: <= 4095</p> +<p>Default value: 0</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |