diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingPPPOE.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingPPPOE.html | 317 |
1 files changed, 317 insertions, 0 deletions
diff --git a/docs/libnm-util/html/NMSettingPPPOE.html b/docs/libnm-util/html/NMSettingPPPOE.html new file mode 100644 index 00000000..baa6bffc --- /dev/null +++ b/docs/libnm-util/html/NMSettingPPPOE.html @@ -0,0 +1,317 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingPPPOE</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="NMSettingPPP.html" title="NMSettingPPP"> +<link rel="next" href="NMSettingVPN.html" title="NMSettingVPN"> +<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="NMSettingPPP.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="NMSettingVPN.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingPPPOE.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingPPPOE.description" class="shortcut">Description</a> + | + <a href="#NMSettingPPPOE.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingPPPOE.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry" title="NMSettingPPPOE"> +<a name="NMSettingPPPOE"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingPPPOE.top_of_page"></a>NMSettingPPPOE</span></h2> +<p>NMSettingPPPOE</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="NMSettingPPPOE.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-SETTING-NAME:CAPS" title="NM_SETTING_PPPOE_SETTING_NAME">NM_SETTING_PPPOE_SETTING_NAME</a> +enum <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEError" title="enum NMSettingPPPOEError">NMSettingPPPOEError</a>; +#define <a class="link" href="NMSettingPPPOE.html#NM-TYPE-SETTING-PPPOE-ERROR:CAPS" title="NM_TYPE_SETTING_PPPOE_ERROR">NM_TYPE_SETTING_PPPOE_ERROR</a> +#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-ERROR:CAPS" title="NM_SETTING_PPPOE_ERROR">NM_SETTING_PPPOE_ERROR</a> +<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-error-quark" title="nm_setting_pppoe_error_quark ()">nm_setting_pppoe_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-SERVICE:CAPS" title="NM_SETTING_PPPOE_SERVICE">NM_SETTING_PPPOE_SERVICE</a> +#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-USERNAME:CAPS" title="NM_SETTING_PPPOE_USERNAME">NM_SETTING_PPPOE_USERNAME</a> +#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-PASSWORD:CAPS" title="NM_SETTING_PPPOE_PASSWORD">NM_SETTING_PPPOE_PASSWORD</a> + <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE-struct" title="NMSettingPPPOE">NMSettingPPPOE</a>; + <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEClass" title="NMSettingPPPOEClass">NMSettingPPPOEClass</a>; +<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-type" title="nm_setting_pppoe_get_type ()">nm_setting_pppoe_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="NMSettingPPPOE.html#nm-setting-pppoe-new" title="nm_setting_pppoe_new ()">nm_setting_pppoe_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-service" title="nm_setting_pppoe_get_service ()">nm_setting_pppoe_get_service</a> (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-username" title="nm_setting_pppoe_get_username ()">nm_setting_pppoe_get_username</a> (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-password" title="nm_setting_pppoe_get_password ()">nm_setting_pppoe_get_password</a> (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="NMSettingPPPOE.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> + +----NMSettingPPPOE +</pre> +</div> +<div class="refsect1" title="Properties"> +<a name="NMSettingPPPOE.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--password" title='The "password" property'>password</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="NMSettingPPPOE.html#NMSettingPPPOE--service" title='The "service" property'>service</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="NMSettingPPPOE.html#NMSettingPPPOE--username" title='The "username" property'>username</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="NMSettingPPPOE.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="NMSettingPPPOE.details"></a><h2>Details</h2> +<div class="refsect2" title="NM_SETTING_PPPOE_SETTING_NAME"> +<a name="NM-SETTING-PPPOE-SETTING-NAME:CAPS"></a><h3>NM_SETTING_PPPOE_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_SETTING_NAME "pppoe" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="enum NMSettingPPPOEError"> +<a name="NMSettingPPPOEError"></a><h3>enum NMSettingPPPOEError</h3> +<pre class="programlisting">typedef enum +{ + NM_SETTING_PPPOE_ERROR_UNKNOWN = 0, + NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY, + NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY, + NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING +} NMSettingPPPOEError; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_TYPE_SETTING_PPPOE_ERROR"> +<a name="NM-TYPE-SETTING-PPPOE-ERROR:CAPS"></a><h3>NM_TYPE_SETTING_PPPOE_ERROR</h3> +<pre class="programlisting">#define NM_TYPE_SETTING_PPPOE_ERROR (nm_setting_pppoe_error_get_type ()) +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_PPPOE_ERROR"> +<a name="NM-SETTING-PPPOE-ERROR:CAPS"></a><h3>NM_SETTING_PPPOE_ERROR</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_ERROR nm_setting_pppoe_error_quark () +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="nm_setting_pppoe_error_quark ()"> +<a name="nm-setting-pppoe-error-quark"></a><h3>nm_setting_pppoe_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_pppoe_error_quark (<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_PPPOE_SERVICE"> +<a name="NM-SETTING-PPPOE-SERVICE:CAPS"></a><h3>NM_SETTING_PPPOE_SERVICE</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_SERVICE "service" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_PPPOE_USERNAME"> +<a name="NM-SETTING-PPPOE-USERNAME:CAPS"></a><h3>NM_SETTING_PPPOE_USERNAME</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_USERNAME "username" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NM_SETTING_PPPOE_PASSWORD"> +<a name="NM-SETTING-PPPOE-PASSWORD:CAPS"></a><h3>NM_SETTING_PPPOE_PASSWORD</h3> +<pre class="programlisting">#define NM_SETTING_PPPOE_PASSWORD "password" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NMSettingPPPOE"> +<a name="NMSettingPPPOE-struct"></a><h3>NMSettingPPPOE</h3> +<pre class="programlisting">typedef struct _NMSettingPPPOE NMSettingPPPOE;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="NMSettingPPPOEClass"> +<a name="NMSettingPPPOEClass"></a><h3>NMSettingPPPOEClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingPPPOEClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="nm_setting_pppoe_get_type ()"> +<a name="nm-setting-pppoe-get-type"></a><h3>nm_setting_pppoe_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_pppoe_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_pppoe_new ()"> +<a name="nm-setting-pppoe-new"></a><h3>nm_setting_pppoe_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_pppoe_new (<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_pppoe_get_service ()"> +<a name="nm-setting-pppoe-get-service"></a><h3>nm_setting_pppoe_get_service ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_service (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre> +<p> +</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> +</td> +</tr> +<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_pppoe_get_username ()"> +<a name="nm-setting-pppoe-get-username"></a><h3>nm_setting_pppoe_get_username ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_username (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre> +<p> +</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> +</td> +</tr> +<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_pppoe_get_password ()"> +<a name="nm-setting-pppoe-get-password"></a><h3>nm_setting_pppoe_get_password ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_password (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre> +<p> +</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> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Property Details"> +<a name="NMSettingPPPOE.property-details"></a><h2>Property Details</h2> +<div class="refsect2" title='The "password" property'> +<a name="NMSettingPPPOE--password"></a><h3>The <code class="literal">"password"</code> property</h3> +<pre class="programlisting"> "password" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Password used to authenticate with the PPPoE service. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "service" property'> +<a name="NMSettingPPPOE--service"></a><h3>The <code class="literal">"service"</code> property</h3> +<pre class="programlisting"> "service" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +If specified, instruct PPPoE to only initiate sessions with access +concentrators that provide the specified serivce. For most providers, +this should be left blank. It is only required if there are multiple +access concentrators or a specific service is known to be required. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "username" property'> +<a name="NMSettingPPPOE--username"></a><h3>The <code class="literal">"username"</code> property</h3> +<pre class="programlisting"> "username" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Username used to authenticate with the PPPoE service. +</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 |