diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingGeneric.html')
-rw-r--r-- | docs/libnm-util/html/NMSettingGeneric.html | 198 |
1 files changed, 198 insertions, 0 deletions
diff --git a/docs/libnm-util/html/NMSettingGeneric.html b/docs/libnm-util/html/NMSettingGeneric.html new file mode 100644 index 000000000..9a758659d --- /dev/null +++ b/docs/libnm-util/html/NMSettingGeneric.html @@ -0,0 +1,198 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingGeneric</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<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="NMSettingTeamPort.html" title="NMSettingTeamPort"> +<link rel="next" href="NMSettingInfiniband.html" title="NMSettingInfiniband"> +<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="NMSettingTeamPort.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="NMSettingInfiniband.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingGeneric.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingGeneric.description" class="shortcut">Description</a> + | + <a href="#NMSettingGeneric.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingGeneric"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingGeneric.top_of_page"></a>NMSettingGeneric</span></h2> +<p>NMSettingGeneric — Describes connection properties for generic devices</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingGeneric.synopsis"></a><h2>Synopsis</h2> +<a name="NMSettingGenericError"></a><pre class="synopsis"> +#include <nm-setting-generic.h> + +#define <a class="link" href="NMSettingGeneric.html#NM-SETTING-GENERIC-SETTING-NAME:CAPS" title="NM_SETTING_GENERIC_SETTING_NAME">NM_SETTING_GENERIC_SETTING_NAME</a> +enum <a class="link" href="NMSettingGeneric.html#NMSettingGenericError-enum" title="enum NMSettingGenericError">NMSettingGenericError</a>; +#define <a class="link" href="NMSettingGeneric.html#NM-SETTING-GENERIC-ERROR:CAPS" title="NM_SETTING_GENERIC_ERROR">NM_SETTING_GENERIC_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="NMSettingGeneric.html#nm-setting-generic-error-quark" title="nm_setting_generic_error_quark ()">nm_setting_generic_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); + <a class="link" href="NMSettingGeneric.html#NMSettingGeneric-struct" title="NMSettingGeneric">NMSettingGeneric</a>; + <a class="link" href="NMSettingGeneric.html#NMSettingGenericClass" title="NMSettingGenericClass">NMSettingGenericClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingGeneric.html#nm-setting-generic-new" title="nm_setting_generic_new ()">nm_setting_generic_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingGeneric.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GEnum + +----NMSettingGenericError +</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> + +----NMSettingGeneric +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingGeneric.description"></a><h2>Description</h2> +<p> +The <a class="link" href="NMSettingGeneric.html" title="NMSettingGeneric"><span class="type">NMSettingGeneric</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes +optional properties that apply to "generic" devices (ie, devices that +NetworkManager does not specifically recognize). +</p> +<p> +There are currently no properties on this object; it exists only to be +the "connection type" setting on <a href="NMConnection.html"><span class="type">NMConnections</span></a> for generic devices. +</p> +</div> +<div class="refsect1"> +<a name="NMSettingGeneric.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NM-SETTING-GENERIC-SETTING-NAME:CAPS"></a><h3>NM_SETTING_GENERIC_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_GENERIC_SETTING_NAME "generic" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGenericError-enum"></a><h3>enum NMSettingGenericError</h3> +<pre class="programlisting">typedef enum { + NM_SETTING_GENERIC_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ + NM_SETTING_GENERIC_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/ + NM_SETTING_GENERIC_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ +} NMSettingGenericError; +</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><a name="NM-SETTING-GENERIC-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GENERIC_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GENERIC-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GENERIC_ERROR_INVALID_PROPERTY</code></span></p></td> +<td>the property was invalid +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-GENERIC-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_GENERIC_ERROR_MISSING_PROPERTY</code></span></p></td> +<td>the property was missing and +is required +</td> +</tr> +</tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-GENERIC-ERROR:CAPS"></a><h3>NM_SETTING_GENERIC_ERROR</h3> +<pre class="programlisting">#define NM_SETTING_GENERIC_ERROR nm_setting_generic_error_quark () +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-generic-error-quark"></a><h3>nm_setting_generic_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_generic_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMSettingGeneric.html" title="NMSettingGeneric"><span class="type">NMSettingGeneric</span></a> if necessary. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<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="NMSettingGeneric.html" title="NMSettingGeneric"><span class="type">NMSettingGeneric</span></a> errors.</td> +</tr></tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGeneric-struct"></a><h3>NMSettingGeneric</h3> +<pre class="programlisting">typedef struct _NMSettingGeneric NMSettingGeneric;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingGenericClass"></a><h3>NMSettingGenericClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingGenericClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-generic-new"></a><h3>nm_setting_generic_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_generic_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingGeneric.html" title="NMSettingGeneric"><span class="type">NMSettingGeneric</span></a> object with default values. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<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="NMSettingGeneric.html" title="NMSettingGeneric"><span class="type">NMSettingGeneric</span></a> object. <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> +<p class="since">Since 0.9.10</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html>
\ No newline at end of file |